flutter_background_geolocation library
BackgroundGeolocation
The primary APIs for the plugin are exposed through two classes:
📚 Help
- 📘 Philosophy of Operation
- 📘 HTTP Guide: HttpConfig.
- 📘 Geofencing Guide: GeofenceEvent.
- 📘 Android Headless Mode.
- 📘 Android Custom Notification Layout.
- 📘 Debugging Guide.
Classes
- Activity
-
Device motion-activity when this
Locationwas recorded. - ActivityChangeEvent
- Event object provided to BackgroundGeolocation.onActivityChange.
- ActivityConfig
- Activity Recognition Configuration.
- AppConfig
- Application & lifecycle configuration.
- Authorization
- Authorization Configuration
- AuthorizationEvent
- Event object provided to BackgroundGeolocation.onAuthorization.
- BackgroundGeolocation
- Primary plugin API.
- Battery
- Device battery information.
- Config
- Configuration API.
- ConnectivityChangeEvent
- Event object provided to BackgroundGeolocation.onConnectivityChange.
- Coords
-
Location coordinates (eg:
latitude,longitude,accuracy,speed,heading, etc. - DeviceInfo
- Returns basic device information, including model, manufacturer, version & platform`.
- DeviceSettings
- Device Settings API.
- DeviceSettingsRequest
- An object for redirecting a User to an Android device's settings screen from a DeviceSettings request.
- Error
- Event
- Event constants
- GeoConfig
- Geolocation Configuration.
- Geofence
- Circular Geofence class provided to BackgroundGeolocation.addGeofence, BackgroundGeolocation.addGeofences
- GeofenceEvent
- Event-object provided to BackgroundGeolocation.onGeofence.
- GeofencesChangeEvent
- Event object provided to BackgroundGeolocation.onGeofencesChange.
- HeadlessEvent
- Event object provided to BackgroundGeolocation.registerHeadlessTask
- HeartbeatEvent
- Event object provided to BackgroundGeolocation.onHeartbeat.
- HttpConfig
- HTTP / Networking Configuration
- HttpEvent
- Event object provided to BackgroundGeolocation.onHttp.
- Location
- Location object provided to:
- LocationError
- Location Error
- LocationFilter
- Defines how raw GPS location samples are filtered, denoised, and smoothed before being recorded or used for odometer calculations.
- Logger
- Logger API
- LoggerConfig
- Logging / Diagnostics Configuration
- MacroConfigFilter
- Defines how raw GPS location samples are filtered, denoised, and smoothed before being recorded or used for odometer calculations.
- Notification
- (Android only) The Android operating system requires a persistent notification when running a foreground service.
- PermissionRationale
- PersistenceConfig
- Persistence / Storage Configuration
- ProviderChangeEvent
- Event object provided to BackgroundGeolocation.onProviderChange
- Sensors
- Expresses the presence of detected motion-related sensors of the device.
- SQLQuery
- Used for selecting a range of records from the SDK's database. Used with the methods Logger.getLog, Logger.emailLog and Logger.uploadLog.
- State
-
Expresses the current state of the plugin, including all Config options.
Compound groups (app, geolocation, http, activity, persistence, logger)
are guaranteed non-null on State via default empty instances, so you can access them without
?. - TransistorAuthorizationToken
- Use TransistorAuthorizationToken.findOrCreate to generate an Authorization token suitable for configuring the SDK's Authorization with Transistor Software's Demo Server at http://tracker.transistorsoft.com.
Enums
- ActivityType
-
Represents iOS-specific activity types used by CoreLocation’s
activityType. - DesiredAccuracy
- Represents the desired location accuracy level for GeoConfig.desiredAccuracy.
- KalmanProfile
- Specifies the preset tuning profile for the Kalman filter used in location denoising.
- LocationFilterPolicy
- Defines the filtering policy applied to incoming raw GPS samples before they are accepted, averaged, or rejected by the LocationFilter.
- LogLevel
- Represents the verbosity level of the SDK’s internal logger.
- NotificationPriority
- Defines the priority / visibility of the Android foreground-service notification.
- PersistMode
- Enum for persistence mode.