TraceletHostApi class
Constructors
TraceletHostApi ({BinaryMessenger ?binaryMessenger , String messageChannelSuffix = ''
Constructor for TraceletHostApi . The binaryMessenger named argument is
available for dependency injection. If it is left null, the default
BinaryMessenger will be used which routes to the host platform.
Methods
addGeofence (TlGeofence geofence → Future <bool
Add a single geofence.
addGeofences (List <TlGeofence geofences → Future <bool
Add multiple geofences.
addPrivacyZone (Map <String Object ? zone → Future <bool
Add a privacy zone.
addPrivacyZones (List <Map <String Object ? zones → Future <bool
Add multiple privacy zones.
canScheduleExactAlarms ()
→ Future <bool
Check if exact alarms can be scheduled (Android 12+).
changePace (bool isMoving → Future <bool
Toggle motion state.
clearRouteContext ()
→ Future <bool
Clear route context.
destroyLocation (String uuid → Future <bool
Delete a single location by UUID.
destroyLocations ()
→ Future <bool
Delete all stored locations.
destroyLog ()
→ Future <bool
Destroy all log entries.
destroySyncedLocations ()
→ Future <int
Delete only synced locations from the database. Returns count deleted.
emailLog (String email → Future <bool
Email the log.
encryptDatabase ()
→ Future <bool
Encrypt the database (one-time migration).
geofenceExists (String identifier → Future <bool
Check if a geofence exists.
getAttestationToken ()
→ Future <Map <String Object ? ?
Get a device attestation token.
getAuditProof (String uuid → Future <Map <String Object ? ?
Get audit proof for a location UUID.
getCarbonReport (Map <String Object ? ?query → Future <Map <String Object ?
Get carbon emissions report.
getCount (Map <String Object ? ?query → Future <int
Get count of stored locations.
getCurrentPosition (TlCurrentPositionOptions options → Future <TlLocation
Get current position with options.
getDeadReckoningState ()
→ Future <Map <String Object ? ?
Get dead reckoning state.
getDeviceInfo ()
→ Future <Map <String Object ?
Get device info.
getGeofence (String identifier → Future <TlGeofence ?
Get a single geofence by identifier.
getGeofences ()
→ Future <List <TlGeofence
Get all registered geofences.
getLastKnownLocation (Map <String Object ? ?options → Future <TlLocation ?
Get last known position without triggering a fix.
getLocations (Map <String Object ? ?query → Future <List <TlLocation
Get stored locations.
getLog (Map <String Object ? ?query → Future <String
Get plugin log.
getMotionPermissionStatus ()
→ Future <int
Get motion/activity recognition permission status.
getNotificationPermissionStatus ()
→ Future <int
Get notification permission status (Android 13+).
getOdometer ()
→ Future <double
Get odometer value in meters.
getPermissionStatus ()
→ Future <TlAuthorizationStatus
Get location permission status.
getPrivacyZones ()
→ Future <List <Map <String Object ?
Get all privacy zones.
getProviderState ()
→ Future <TlProviderChangeEvent
Get location provider state.
getSensors ()
→ Future <Map <String Object ?
Get available sensors.
getSettingsHealth ()
→ Future <Map <String Object ?
Get OEM settings health information.
getState ()
→ Future <TlState
Get current plugin state.
insertLocation (Map <String Object ? params → Future <String
Insert a custom location. Returns UUID.
isDatabaseEncrypted ()
→ Future <bool
Check if database is encrypted.
isIgnoringBatteryOptimizations ()
→ Future <bool
Whether ignoring battery optimizations (Android).
isPowerSaveMode ()
→ Future <bool
Whether device is in power-save mode.
log (String level , String message → Future <bool
Write a custom log entry.
noSuchMethod (Invocation invocation → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
openExactAlarmSettings ()
→ Future <bool
Open exact alarm settings (Android 12+).
openOemSettings (String label → Future <bool
Open an OEM-specific settings screen by label.
playSound (String name → Future <bool
Play a debug sound.
ready (Map <String Object ? config → Future <TlState
Initialize the plugin with configuration. Returns current state.
Register a headless headers callback for background token recovery.
registerHeadlessSyncBodyBuilder (List <int callbackIds → Future <bool
Register a headless sync body builder for background custom payloads.
registerHeadlessTask (List <int callbackIds → Future <bool
Register a headless task callback for background event dispatch.
removeGeofence (String identifier → Future <bool
Remove a geofence by identifier.
removeGeofences ()
→ Future <bool
Remove all geofences.
removePrivacyZone (String identifier → Future <bool
Remove a privacy zone by identifier.
removePrivacyZones ()
→ Future <bool
Remove all privacy zones.
requestMotionPermission ()
→ Future <int
Request motion/activity recognition permission.
requestNotificationPermission ()
→ Future <int
Request notification permission (Android 13+).
requestPermission ()
→ Future <TlAuthorizationStatus
Request location permission. Returns result.
requestSettings (String action → Future <bool
Request a system settings page (e.g., battery optimization).
requestTemporaryFullAccuracy (String purpose → Future <int
Request temporary full accuracy (iOS 14+). Returns accuracy status.
reset (Map <String Object ? ?config → Future <TlState
Reset to defaults. Returns current state.
setConfig (Map <String Object ? config → Future <TlState
Update configuration. Returns current state.
Update dynamic HTTP headers.
setOdometer (double value → Future <TlLocation
Reset odometer. Returns location at reset point.
setRouteContext (Map <String Object ? context → Future <bool
Set route context for subsequent locations.
showSettings (String action → Future <bool
Show a system settings page (e.g., location settings).
start ()
→ Future <TlState
Start location tracking. Returns current state.
startBackgroundTask ()
→ Future <int
Start a background task. Returns task ID.
startGeofences ()
→ Future <TlState
Start geofence-only mode. Returns current state.
startPeriodic ()
→ Future <TlState
Start periodic one-shot mode. Returns current state.
startSchedule ()
→ Future <TlState
Start schedule-based tracking.
stop ()
→ Future <TlState
Stop location tracking. Returns current state.
stopBackgroundTask (int taskId → Future <int
Complete a background task.
stopSchedule ()
→ Future <TlState
Stop schedule-based tracking.
stopWatchPosition (int watchId → Future <bool
Stop a position watch by ID.
sync ()
→ Future <List <TlLocation
Manually trigger HTTP sync. Returns synced locations.
toString ()
→ String
A string representation of this object.
inherited
verifyAuditTrail ()
→ Future <Map <String Object ?
Verify audit trail integrity.
watchPosition (Map <String Object ? options → Future <int
Start watching position at an interval. Returns a watch ID.
tracelet_platform_interface 1.8.10 