Configuration API.

The Config class defines all SDK options, grouped into compound configuration objects:

• GeoConfig — Geolocation and filtering options
• AppConfig — Application lifecycle options
• HttpConfig — Networking and HTTP sync options
• PersistenceConfig — Data persistence and database options
• LoggerConfig — Logging and debugging options
• ActivityConfig — Motion and activity-recognition options

Instances of Config are consumed by BackgroundGeolocation.ready and BackgroundGeolocation.setConfig.

Example

import 'package:flutter_background_geolocation/flutter_background_geolocation.dart' as bg;

void main() async {
  // Configure the SDK with compound configuration objects.
  bg.Config config = bg.Config(
    geolocation: bg.GeoConfig(
      desiredAccuracy: bg.GeoConfig.DESIRED_ACCURACY_HIGH,
      distanceFilter: 20.0,
      stopTimeout: 5,
      stationaryRadius: 150.0,
    ),
    activity: bg.ActivityConfig(
      activityRecognitionInterval: 10000,
      minimumActivityRecognitionConfidence: 75,
      disableStopDetection: false,
      motionTriggerDelay: 30000,
    ),
    http: bg.HttpConfig(
      url: 'https://my.server.com/api/locations',
      method: 'POST',
      autoSync: true,
      headers: {
        'Authorization': 'Bearer secret-token'
      },
      params: {
        'user_id': 123
      },
    ),
    persistence: bg.PersistenceConfig(
      persistMode: bg.PersistenceConfig.PERSIST_MODE_ALL,
      maxDaysToPersist: 14,
      extras: {'appVersion': '1.0.0'},
    ),
    app: bg.AppConfig(
      stopOnTerminate: false,
      startOnBoot: true,
      enableHeadless: true,
      heartbeatInterval: 60,
    ),
    logger: bg.LoggerConfig(
      debug: true,
      logLevel: bg.LoggerConfig.LOG_LEVEL_VERBOSE,
      logMaxDays: 3,
    ),
  );

  // Apply the configuration.
  bg.BackgroundGeolocation.ready(config).then((bg.State state) {
    print('[ready] BackgroundGeolocation is configured and ready to use');

    if (!state.enabled) {
      bg.BackgroundGeolocation.start();
    }
  });

  // To modify configuration after initialization, use [setConfig].
  bg.BackgroundGeolocation.setConfig(bg.Config(
    http: bg.HttpConfig(
      headers: {
        'Authorization': 'Bearer new-token'
      }
    ),
    logger: bg.LoggerConfig(
      logLevel: bg.Config.LOG_LEVEL_INFO
    ),
  )).then((bg.State state) {
    bg.BackgroundGeolocation.sync();
  });
}