Options provided to BackgroundGeolocation.getCurrentPosition.
Effective runtime state returned by BackgroundGeolocation.ready/getState.
Configuration API.
Activity Recognition configuration.
(Android 11+) Configure the dialog shown when requesting Always background location permission.
Application & lifecycle configuration.
Configure the SDK to authenticate with your server using an
access token (e.g., a
JSON Web Token), and automatically request new tokens when
the server returns 401 Unauthorized.
Configuration API.
Geolocation Configuration
HTTP / Networking Configuration
Defines how raw GPS samples are filtered, denoised, and smoothed before being recorded or used for odometer calculations.
Logging & diagnostics configuration.
Android foreground notification
Persistence / Storage Configuration
iOS Activity Type used with GeoConfig.activityType.
Supported authorization strategies. Mirrors Flutter's Authorization.strategy values.
Desired accuracy presets (meters / platform-tuned).
Allowed HTTP methods for uploading data. Mirrors Flutter's HttpConfig.method and native support.
Specifies the preset tuning profile for the Kalman filter used in location denoising.
Defines the filtering policy applied to incoming raw GPS samples before they are accepted, averaged, or rejected by the LocationFilter.
Indicates what level of location authorization the SDK should request.
Controls the verbosity of plugin logging.
Defines the priority / visibility of the Android foreground-service notification.
Persistence modes for BackgroundGeolocation SDK.
Mirrors Flutter's PersistMode enum.
SDK tracking mode (legacy RN values preserved).
Allowed motion activity names that can trigger motion detection. Mirrors Flutter's TriggerActivity set.
Historic, flat configuration surface.
Emitted by BackgroundGeolocation.onAuthorization.
Emitted by BackgroundGeolocation.onConnectivityChange.
Emitted by BackgroundGeolocation.onGeofence.
Emitted by BackgroundGeolocation.onGeofencesChange.
Event for Android headless tasks registered via BackgroundGeolocation.registerHeadlessTask
Emitted by BackgroundGeolocation.onHeartbeat.
Emitted by BackgroundGeolocation.onHttp.
Emitted by BackgroundGeolocation.onActivityChange.
Emitted by BackgroundGeolocation.onMotionChange.
Emitted by BackgroundGeolocation.onProviderChange.
Object returned by BackgroundGeolocation event-listeners.
Accuracy authorization granted by the user.
iOS/Android location authorization status.
Supported event names emitted by the SDK.
Geofence transition actions emitted by the SDK
Error codes returned when the native location API fails to fetch a location.
Reported device motion activity names (legacy RN + native).
Simple device information, as returned by BackgroundGeolocation.getDeviceInfo.
The Background Geolocation SDK implements the native iOS and Android Geofencing APIs.
This object is attached to instances of Location.coords.
This object is attached to instances of Location.battery.
The last known motion-activity when this location was recorded.
A Location object represents a geographic location captured by the device's native location API.
Detected device sensors related to motion-detection.
Used for selecting a range of records from the SDK's log database.
Logger API
Sort order for [[SQLQuery.order]].
An object for redirecting a User to an Android device's settings screen from a DeviceSettings request.
Device Settings API (types-only).
Represents an authorization token issued by a Transistorsoft Tracking Server.
Transistor Software hosts a demo server at tracker.transistorsoft.com which is designed to consume location data from devices running the Background Geolocation SDK.
The Background Geolocation SDK implements the native iOS and Android Geofencing APIs.
Emitted by BackgroundGeolocation.onGeofence.
A list of vertices defining a Polygon geofence
Primary BackgroundGeolocation API