State class
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 ?.
Properties
- activity → ActivityConfig
-
Activity Recognition Configuration.
no setteroverride
- activityRecognitionInterval ↔ int?
-
Deprecated: Use ActivityConfig.activityRecognitionInterval via Config.activity.
getter/setter pairinherited
- activityType ↔ int?
-
Deprecated: Use GeoConfig.activityType via Config.geolocation.
getter/setter pairinherited
- allowIdenticalLocations ↔ bool?
-
Deprecated: Use GeoConfig.allowIdenticalLocations via Config.geolocation.
getter/setter pairinherited
- app → AppConfig
-
Application & lifecycle configuration.
no setteroverride
-
Authorization Configuration
getter/setter pairinherited
- autoSync ↔ bool?
-
Deprecated: Use HttpConfig.autoSync via Config.http.
getter/setter pairinherited
- autoSyncThreshold ↔ int?
-
Deprecated: Use HttpConfig.autoSyncThreshold via Config.http.
getter/setter pairinherited
- backgroundPermissionRationale ↔ PermissionRationale?
-
Deprecated: Use AppConfig.backgroundPermissionRationale via Config.app.
getter/setter pairinherited
- batchSync ↔ bool?
-
Deprecated: Use HttpConfig.batchSync via Config.http.
getter/setter pairinherited
- debug ↔ bool?
-
Logger Config
Deprecated: Use LoggerConfig.debug via Config.logger.
getter/setter pairinherited
- deferTime ↔ int?
-
Deprecated: Use GeoConfig.deferTime via Config.geolocation.
getter/setter pairinherited
- desiredAccuracy ↔ int?
-
Geolocation Config
getter/setter pairinherited
- desiredOdometerAccuracy ↔ double?
-
Deprecated: Use LocationFilter.odometerAccuracyThreshold via
Config.geolocation.filter.getter/setter pairinherited - didDeviceReboot ↔ bool
-
Indicates if the app was launched after the device was rebooted.
getter/setter pair
- didLaunchInBackground ↔ bool
-
Indicates whether the iOS app was launched in the background.
getter/setter pair
- disableAutoSyncOnCellular ↔ bool?
-
Deprecated: Use HttpConfig.disableAutoSyncOnCellular via Config.http.
getter/setter pairinherited
- disableElasticity ↔ bool?
-
Deprecated: Use GeoConfig.disableElasticity via Config.geolocation.
getter/setter pairinherited
- disableLocationAuthorizationAlert ↔ bool?
-
Deprecated: Use GeoConfig.disableLocationAuthorizationAlert via Config.geolocation.
getter/setter pairinherited
- disableMotionActivityUpdates ↔ bool?
-
Deprecated: Use ActivityConfig.disableMotionActivityUpdates via Config.activity.
getter/setter pairinherited
- disableProviderChangeRecord ↔ bool?
-
Deprecated: Use PersistenceConfig.disableProviderChangeRecord via Config.persistence.
getter/setter pairinherited
- disableStopDetection ↔ bool?
-
Deprecated: Use ActivityConfig.disableStopDetection via Config.activity.
getter/setter pairinherited
- distanceFilter ↔ double?
-
Deprecated: Use GeoConfig.distanceFilter via Config.geolocation.
getter/setter pairinherited
- elasticityMultiplier ↔ double?
-
Deprecated: Use GeoConfig.elasticityMultiplier via Config.geolocation.
getter/setter pairinherited
- enabled ↔ bool
-
Whether the plugin is current stopped or started (BackgroundGeolocation.stop / BackgroundGeolocation.start).
getter/setter pair
- enableHeadless ↔ bool?
-
Deprecated: Use AppConfig.enableHeadless via Config.app.
getter/setter pairinherited
- enableTimestampMeta ↔ bool?
-
Deprecated: Use GeoConfig.enableTimestampMeta via Config.geolocation.
getter/setter pairinherited
-
extras
↔ Map<
String, dynamic> ? -
Deprecated: Use PersistenceConfig.extras via Config.persistence.
getter/setter pairinherited
- fastestLocationUpdateInterval ↔ int?
-
Deprecated: Use GeoConfig.fastestLocationUpdateInterval via Config.geolocation.
getter/setter pairinherited
- foregroundService ↔ bool?
-
Deprecated: No longer used; always
true.getter/setter pairinherited - geofenceInitialTriggerEntry ↔ bool?
-
Deprecated: Use GeoConfig.geofenceInitialTriggerEntry via Config.geolocation.
getter/setter pairinherited
- geofenceModeHighAccuracy ↔ bool?
-
Deprecated: Use GeoConfig.geofenceModeHighAccuracy via Config.geolocation.
getter/setter pairinherited
- geofenceProximityRadius ↔ int?
-
Deprecated: Use GeoConfig.geofenceProximityRadius via Config.geolocation.
getter/setter pairinherited
- geofenceTemplate ↔ String?
-
Deprecated: Use PersistenceConfig.geofenceTemplate via Config.persistence.
getter/setter pairinherited
- geolocation → GeoConfig
-
Geolocation Configuration.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
-
headers
↔ Map<
String, dynamic> ? -
Deprecated: Use HttpConfig.headers via Config.http.
getter/setter pairinherited
- heartbeatInterval ↔ int?
-
Deprecated: Use AppConfig.heartbeatInterval via Config.app.
getter/setter pairinherited
- http → HttpConfig
-
HTTP / Networking Configuration
no setteroverride
- httpRootProperty ↔ String?
-
Deprecated: Use HttpConfig.rootProperty via Config.http.
getter/setter pairinherited
- httpTimeout ↔ int?
-
Deprecated: Use HttpConfig.timeout via Config.http.
getter/setter pairinherited
- isFirstBoot ↔ bool
-
Indicates if this is the first launch of the app after initial install
getter/setter pair
- isMoving ↔ bool?
-
Activity-recognition Config
Configure the SDK's initial state to tracking with location-services ON.
getter/setter pairinherited
-
locationAuthorizationAlert
↔ Map<
String, dynamic> ? -
Deprecated: Use GeoConfig.locationAuthorizationAlert via Config.geolocation.
getter/setter pairinherited
- locationAuthorizationRequest ↔ String?
-
Deprecated: Use GeoConfig.locationAuthorizationRequest via Config.geolocation.
getter/setter pairinherited
- locationsOrderDirection ↔ String?
-
Deprecated: Use PersistenceConfig.locationsOrderDirection via Config.persistence.
getter/setter pairinherited
- locationTemplate ↔ String?
-
Deprecated: Use PersistenceConfig.locationTemplate via Config.persistence.
getter/setter pairinherited
- locationTimeout ↔ int?
-
Deprecated: Use GeoConfig.locationTimeout via Config.geolocation.
getter/setter pairinherited
- locationUpdateInterval ↔ int?
-
Deprecated: Use GeoConfig.locationUpdateInterval via Config.geolocation.
getter/setter pairinherited
- logger → LoggerConfig
-
Logging / Diagnostics Configuration
no setteroverride
- logLevel ↔ int?
-
Deprecated: Use LoggerConfig.logLevel via Config.logger.
getter/setter pairinherited
- logMaxDays ↔ int?
-
Deprecated: Use LoggerConfig.logMaxDays via Config.logger.
getter/setter pairinherited
- map ↔ Map
-
latefinal
- maxBatchSize ↔ int?
-
Deprecated: Use HttpConfig.maxBatchSize via Config.http.
getter/setter pairinherited
- maxDaysToPersist ↔ int?
-
Deprecated: Use PersistenceConfig.maxDaysToPersist via Config.persistence.
getter/setter pairinherited
- maxMonitoredGeofences ↔ int?
-
Deprecated: Use GeoConfig.maxMonitoredGeofences via Config.geolocation.
getter/setter pairinherited
- maxRecordsToPersist ↔ int?
-
Deprecated: Use PersistenceConfig.maxRecordsToPersist via Config.persistence.
getter/setter pairinherited
- method ↔ String?
-
Deprecated: Use HttpConfig.method via Config.http.
getter/setter pairinherited
- minimumActivityRecognitionConfidence ↔ int?
-
Deprecated: Use ActivityConfig.minimumActivityRecognitionConfidence via Config.activity.
getter/setter pairinherited
- motionTriggerDelay ↔ int?
-
Deprecated: Use ActivityConfig.motionTriggerDelay via Config.activity.
getter/setter pairinherited
- notification ↔ Notification?
-
Deprecated: Use AppConfig.notification via Config.app.
getter/setter pairinherited
- odometer ↔ double
-
Current distance traveled.
getter/setter pair
-
params
↔ Map<
String, dynamic> ? -
Deprecated: Use HttpConfig.params via Config.http.
getter/setter pairinherited
- pausesLocationUpdatesAutomatically ↔ bool?
-
Deprecated: Use GeoConfig.pausesLocationUpdatesAutomatically via Config.geolocation.
getter/setter pairinherited
- persistence → PersistenceConfig
-
Persistence / Storage Configuration
no setteroverride
- persistMode ↔ int?
-
Persistence Config
Deprecated: Use PersistenceConfig.persistMode via Config.persistence.
getter/setter pairinherited
- preventSuspend ↔ bool?
-
Deprecated: Use AppConfig.preventSuspend via Config.app.
getter/setter pairinherited
- reset ↔ bool?
-
Determines whether to reset the existing Config to defaults before appying new config (default true)
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
schedule
↔ List<
String> ? -
Deprecated: Use AppConfig.schedule via Config.app.
getter/setter pairinherited
- schedulerEnabled ↔ bool
-
Whether the plugin's AppConfig.schedule has been activated with BackgroundGeolocation.startSchedule.
getter/setter pair
- scheduleUseAlarmManager ↔ bool?
-
Deprecated: Use AppConfig.scheduleUseAlarmManager via Config.app.
getter/setter pairinherited
- showsBackgroundLocationIndicator ↔ bool?
-
Deprecated: Use GeoConfig.showsBackgroundLocationIndicator via Config.geolocation.
getter/setter pairinherited
- speedJumpFilter ↔ int?
-
Deprecated: Use GeoConfig.filter settings via Config.geolocation.
getter/setter pairinherited
- startOnBoot ↔ bool?
-
Deprecated: Use AppConfig.startOnBoot via Config.app.
getter/setter pairinherited
- stationaryRadius ↔ double?
-
Deprecated: Use GeoConfig.stationaryRadius via Config.geolocation.
getter/setter pairinherited
- stopAfterElapsedMinutes ↔ int?
-
Deprecated: Use GeoConfig.stopAfterElapsedMinutes via Config.geolocation.
getter/setter pairinherited
- stopDetectionDelay ↔ int?
-
Deprecated: Use ActivityConfig.stopDetectionDelay via Config.activity.
getter/setter pairinherited
- stopOnStationary ↔ bool?
-
Deprecated: Use ActivityConfig.stopOnStationary via Config.activity.
getter/setter pairinherited
- stopOnTerminate ↔ bool?
-
Application Config
Deprecated: Use AppConfig.stopOnTerminate via Config.app.
getter/setter pairinherited
- stopTimeout ↔ int?
-
Deprecated: Use GeoConfig.stopTimeout via Config.geolocation.
getter/setter pairinherited
- trackingMode ↔ int
-
Whether the plugin is in the location-tracking mode (BackgroundGeolocation.start or geofences-only mode (BackgroundGeolocation.startGeofences).
getter/setter pair
- transistorAuthorizationToken ↔ TransistorAuthorizationToken?
-
Convenience option to automatically configures the SDK to upload locations to the Transistor Software demo server at http://tracker.transistorsoft.com (or your own local instance of background-geolocation-console)
getter/setter pairinherited
- triggerActivities ↔ String?
-
Deprecated: Use ActivityConfig.triggerActivities via Config.activity.
getter/setter pairinherited
- url ↔ String?
-
HTTP Config
Deprecated: Use HttpConfig.url via Config.http.
getter/setter pairinherited
- useSignificantChangesOnly ↔ bool?
-
Deprecated: Use GeoConfig.useSignificantChangesOnly via Config.geolocation.
getter/setter pairinherited
Methods
-
compoundToMap(
) → Map< String, dynamic> -
Returns only the compound config groups as a Map suitable for marshalling.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
set(
String key, dynamic value) → Config -
inherited
-
toMap(
) → Map? -
inherited
-
toString(
) → String -
Return String representation of
Stateforprintto log.override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited