Common topic

Provides lightweight, reusable building blocks and value objects used across the Magic Lane Maps SDK for Flutter. Use this module to manage global SDK lifecycle, error handling, typed parameter containers, progress tracking, versioning, and compact value objects for routing and transfer statistics. These primitives power higher-level services (routing, navigation, content management, search) and make it easy to pass structured data and monitor asynchronous operations consistently.

• GemKit: The global SDK entrypoint. Use GemKit to initialize and release the Magic Lane SDK and to configure global options such as automatic content updates during startup.
• AutoUpdateSettings: Configuration model that controls which content types are checked and updated automatically. Provide this when initializing the SDK to enable or disable automatic updates for maps, styles, voices, and resources.
• GemError: Standardized error enum used across the SDK. Inspect this value after operations to determine success or detailed failure reasons.
• ApiErrorService: Central place to read the last API error and register for error updates. Use this to retrieve or subscribe to the most recent SDK error when a method does not return an explicit error value.
• GemParameter: Typed key/value parameter used throughout the SDK to represent arbitrary metadata used by many SDK components.
• ParameterList: Iterable container for GemParameter instances. Use it to collect parameter sets, convert them to Dart lists, or produce deep JSON structures ready for inspection.
• SearchableParameterList: Extension of ParameterList with convenience search helpers. Use it to find parameters by key, fetch display names, or retrieve parameter objects by identifier.
• ProgressListener: Abstract interface for tracking progress and completion of long-running operations. Many async SDK operations return or accept progress listeners so you can monitor progress, cancel work, and receive completion callbacks.
• RoadInfo: Small value object describing a road label and its shield classification. Use it to render or interpret road name metadata returned by routing, positioning and instruction APIs.
• TaskHandler: Lightweight handle for running asynchronous tasks. Returned by many service methods to allow cancellation of in-progress work.
• TimeDistance: Compact value object separating unrestricted and restricted time/distance components. Obtain this from routing and navigation results to present detailed ETA information.
• TransferStatistics: Object exposing upload/download/request counters with per-network breakdowns. Request and inspect transfer statistics for specific online services to implement monitoring or quota logic.
• TurnDetails: Navigation-focused value describing a manoeuvre and its geometry. Use it to obtain schematic geometry, vector/raster images for turn visuals, and event metadata for driving directions.
• Version: Compact major/minor version holder for content items. Useful when comparing installed versus available content versions.
• SdkVersion: Deprecated container for SDK version components; present for backwards compatibility and for reading or serializing SDK build details.

The Common components provide consistent data models and control primitives that simplify interaction with the rest of the SDK. Together they reduce boilerplate by standardizing error handling, serialization, progress reporting, and compact data transport.