flutter_background_geolocation library
BackgroundGeolocation
The primary APIs for the plugin are exposed through two classes:
📚 Help
- 📘 Philosophy of Operation
- 📘 HTTP Guide: HttpEvent.
- 📘 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.
- Authorization
-
Configures the SDK for authorization wtih your server's accessToken token (eg: JSON Web Token) and automatically requests new tokens when server returns HTTP status
"401 Unauthorized". - 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
- 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.
- HttpEvent
- Event object provided to BackgroundGeolocation.onHttp.
- Location
- Location object provided to:
- LocationError
- Location Error
- Logger
- Logger API
- Notification
- (Android only) The Android operating system requires a persistent notification when running a foreground service.
- PermissionRationale
- 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.
- 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.