geolocation 0.1.1

Geolocation plugin for iOS and Android

Geolocation

Flutter geolocation plugin working on Android API 16+ and iOS 9+.

Features:

• Managing permissions automatically
• Retrieving last known location
• Requesting single location update

The plugin is under active development and the following features are planned soon:

• Continuous location updates with foreground and background strategies
• Geocode
• Geofences
• Place suggestions
• Activity recognition

Android	iOS

Installation

Add geolocation to your pubspec.yaml:

dependencies:
  geolocation: ^0.1.1

Note: There is a known issue for integrating swift written plugin into Flutter project created with Objective-C template. See #16049 for help on integration.

Permission

Apps need to declare the desired location permission in configuration file and request it at runtime. Geolocation plugin automatically checks at runtime if the configuration is correct, and throws an exception otherwise.

iOS configuration

There are two kinds of location permission in iOS: "when in use" and "always". You will request one or another depending if the app requires to use location while being in background. You need to specify the description for the desired permission in Infos.plist.

When targeting iOS 9/10: NSLocationWhenInUseUsageDescription or NSLocationAlwaysUsageDescription

When targeting iOS 11+: NSLocationAlwaysAndWhenInUseUsageDescription or NSLocationWhenInUseUsageDescription

Geolocation will automatically request the associated permission at runtime, based on the content of Infos.plist.

Android configuration

There are two kinds of location permission in Android: "coarse" and "fine". Coarse location will allow to get approximate location based on sensors like the Wifi, while fine location returns the most accurate location using GPS (in addition to coarse).

You need to declare one of those permissions in AndroidManifest.xml:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
  package="some.app">
  <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
  <!-- or -->
  <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
</manifest>

Note that ACCESS_FINE_LOCATION permission includes ACCESS_COARSE_LOCATION.

Runtime request

On Android (api 23+) and iOS, apps need to request permission at runtime. Geolocation plugin handles this automatically. If the user denies location permission, location result will return an error of type GeolocationResultErrorType.permissionDenied.

Location API

Get the last known location

See api documentation: [link]

LocationResult result = await Geolocation.lastKnownLocation;

Get the current location

See api documentation: [link]

LocationResult result = await Geolocation.currentLocation(LocationAccuracy.best);

Get a single location update

See api documentation: [link]

LocationResult result = await Geolocation.singleLocationUpdate(LocationAccuracy.best);

Result

All location API return a LocationResult future.

final LocationResult result = await Geolocation.lastKnownLocation;

if (result.isSuccessful) {
  // location request successful, location is guaranteed to not be null 
  double lat = result.location.latitude;
  double lng = result.location.longitude;
} else {
  switch (result.error.type) {
    case GeolocationResultErrorType.runtime:
      // runtime error, check result.error.message
      break;
    case GeolocationResultErrorType.locationNotFound:
      // location request did not return any result
      break;
    case GeolocationResultErrorType.serviceDisabled:
      // location services disabled on device
      // might be that GPS is turned off, or parental control (android) 
      break;
    case GeolocationResultErrorType.permissionDenied:
      // user denied location permission request
      // rejection is final on iOS, and can be on Android
      // user will need to manually allow the app from the settings
      break;
    case GeolocationResultErrorType.playServicesUnavailable:
      // android only
      // result.error.additionalInfo contains more details on the play services error
      switch(result.error.additionalInfo as GeolocationAndroidPlayServices) {
        // do something, like showing a dialog inviting the user to install/update play services
        case GeolocationAndroidPlayServices.missing:
        case GeolocationAndroidPlayServices.updating:
        case GeolocationAndroidPlayServices.versionUpdateRequired:
        case GeolocationAndroidPlayServices.disabled:
        case GeolocationAndroidPlayServices.invalid:
      }
    break;
  }
}

Author

Geolocation plugin is developed by Loup, a mobile development studio based in Montreal and Paris.
You can contact us at [e-mail]

License

Apache License 2.0