Debug class abstract Settings

Provides debugging utilities for memory monitoring, logging, and SDK configuration.

The Debug class offers static methods for monitoring memory usage, controlling log output, configuring routing and navigation behavior, and retrieving SDK diagnostics. Key features include:

  • Memory monitoring: Track used, free, and maximum memory consumption
  • Logging system: Send logs to Magic Lane servers for crash analysis
  • Debug flags: Control console output for object creation, method calls, and listeners
  • Routing/Navigation modifiers: Alter algorithm behavior for testing
  • Storage information: Monitor mount points and disk space

See also:

Constructors

Debug()

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

allWeatherConditions LocationForecast
Retrieve all weather conditions parsed from all available resources.
no setter
androidVersion int
Returns the Android version of the device.
no setter
appIOInfo List<MountInfo>
Get app I/O info
no setter
freeMemory int
Returns the free system memory including swap and kernel cache.
no setter
isObjectAliveCheckEnabled bool
In enabled checks if an object is alive before calling a method on it.
getter/setter pair
logCallObjectMethod bool
If enabled prints method object calls JSONs to the console
getter/setter pair
logCreateObject bool
If enabled prints create object calls JSONs to the console
getter/setter pair
logLevel GemLoggingLevel
Gets the current console logging level for SDK debug output.
getter/setter pair
logListenerMethod bool
If enabled prints listener messages JSONs to the console
getter/setter pair
mainThread bool
Check if the current thread is the main thread.
no setter
mapViewMaxZoomRanges int
Retrieve the maximum zoom ranges allowed on a MapView
no setter
maxUsedMemory int
Returns the maximum memory used by the SDK engine since initialization.
no setter
Retrieve the current navigation location modifiers.
no setter
rawPositionTrackerEnabled bool
Check if raw position tracker is enabled
no setter
routingAlgoModifiers Set<RoutingAlgoModifiers>
Retrieve current routing algorithm modifiers.
no setter
sdkLogDumpPath Future<String>
Retrieves the file path to the SDK crash report log.
no setter
servicesIds List<int>
Retrieve a list of service IDs used within the application.
no setter
styleBuilderUrls List<String>
Get URLs for the style builder.
no setter
timeToBetterRoute int
Get the remaining time in seconds until the next check for a better route.
no setter
timeToCheckTrafficAlongRoutes int
Get the remaining time in seconds until the next check for traffic conditions along all routes.
no setter
totalMemory int
Returns the total system memory available to the device.
no setter
usedMemory int
Returns the memory currently used by the SDK engine.
no setter

Static Methods

checkBetterRoute() bool
Initiate a check for a better route.
checkTrafficAlongRoutes() bool
Initiate a check for traffic conditions along all routes.
cleanupSocialCache() → void
Refresh the content store by loading external changes from disk.
getAllWeatherConditions() LocationForecast
Retrieve all weather conditions parsed from all available resources.
getAndroidVersion() int
Returns the Android version of the device.
getAppIOInfo() List<MountInfo>
Get app I/O info
getDefUrls(ServiceGroupType svc) List<String>
Get default URLs for the specified service.
getFreeMemory() int
Returns the free system memory including swap and kernel cache.
getMapViewMaxZoomRanges() int
Retrieve the maximum zoom ranges allowed on a MapView
getMaxUsedMemory() int
Returns the maximum memory used by the SDK engine since initialization.
getNavigationModifiers() Set<NavigationModifiers>
Retrieve the current navigation location modifiers.
getRouteConnections(Route route) MarkerCollection?
Retrieve connections for a given route as markers.
getRoutingAlgoModifiers() Set<RoutingAlgoModifiers>
Retrieve current routing algorithm modifiers.
getSdkLogDumpPath() Future<String>
Retrieves the file path to the SDK crash report log.
getServiceName(int id) String
Retrieve the name of a service given its ID.
getServicesIds() List<int>
Retrieve a list of service IDs used within the application.
getStyleBuilderUrls() List<String>
Get URLs for the style builder.
getTotalMemory() int
Returns the total system memory available to the device.
getUsedMemory() int
Returns the memory currently used by the SDK engine.
isMainThread() bool
Check if the current thread is the main thread.
isRawPositionTrackerEnabled() bool
Check if raw position tracker is enabled
log({required GemDumpSdkLevel level, String module = 'Application', String function = '', String file = '', int line = 0, required String message}) → void
Writes a log message to the SDK logging system for crash analysis.
manyToManyPedestrianCalculation(Coordinates start, Coordinates end) → void
Perform a many-to-many pedestrian routing calculation.
oneToOnePedestrianCalculation(Coordinates start, Coordinates end) → void
Perform a one-to-one pedestrian routing calculation.
refreshContentStore() → void
Refresh the content store by loading external changes from disk.
replayStreamActivityLog(String path) GemError
Replay a previously recorded stream activity log.
setCustomUrl(int svc, String url) → void
Get default URLs for the specified service.
setNavigationModifiers(Set<NavigationModifiers> modifiers) → void
Set modifiers for navigation locations.
setRoutingAlgoModifiers(Set<RoutingAlgoModifiers> modifiers) → void
Set modifiers for the routing algorithm to alter its behavior.
setSdkDumpLevel(GemDumpSdkLevel level) Future<void>
Sets the verbosity level for crash report logs sent to Magic Lane.
timeToBetterRouteSec() int
Get the remaining time until the next check for a better route.
timeToCheckTrafficAlongRoutesSec() int
Get the remaining time until the next check for traffic conditions along all routes.
updateMaps(bool force) GemError
Update maps to the latest version synchronously.