Installation

iOS

Objective-C compatibility

Android

AndroidX

android.useAndroidX=trueandroid.enableJetifier=true

R8/Proguard code obfuscation

buildTypes {  release {    minifyEnabledtrue    proguardFiles getDefaultProguardFile('proguard-android.txt'),'proguard-rules.pro'  }}

# Geolocation - start-keep class app.loup.geolocation.** { *; }    # Moshi - start    # https://github.com/square/moshi/blob/master/moshi/src/main/resources/META-INF/proguard/moshi.pro    # JSR 305 annotations are for embedding nullability information.    -dontwarn javax.annotation.**    -keepclasseswithmembers class * {        @com.squareup.moshi.* <methods>;    }    -keep @com.squareup.moshi.JsonQualifier interface *    # Enum field names are used by the integrated EnumJsonAdapter.    # values() is synthesized by the Kotlin compiler and is used by EnumJsonAdapter indirectly    # Annotate enums with @JsonClass(generateAdapter = false) to use them with Moshi.    -keepclassmembers @com.squareup.moshi.JsonClass class * extends java.lang.Enum {        <fields>;        **[] values();    }    # Moshi - end# Geolocation - end

Permission

For iOS

<dict><!-- for iOS 11 +-->  <key>NSLocationWhenInUseUsageDescription</key>  <string>Reason why app needs location</string>  <key>NSLocationAlwaysAndWhenInUseUsageDescription</key>  <string>Reason why app needs location</string><!-- additionally for iOS 9/10, if you need always permission-->  <key>NSLocationAlwaysUsageDescription</key>  <string>Reason why app needs location</string>  ...</dict>

For Android

<manifestxmlns:android="http://schemas.android.com/apk/res/android">  <uses-permissionandroid:name="android.permission.ACCESS_COARSE_LOCATION" /><!-- or-->  <uses-permissionandroid:name="android.permission.ACCESS_FINE_LOCATION" /></manifest>

API

Check if location service is operational

finalGeolocationResult result=awaitGeolocation.isLocationOperational();if(result.isSuccessful) {// location service is enabled, and location permission is granted}else {// location service is not enabled, restricted, or location permission is denied}

Request location permission

finalGeolocationResult result=awaitGeolocation.requestLocationPermission(constLocationPermission(    android:LocationPermissionAndroid.fine,    ios:LocationPermissionIOS.always,  ),  openSettingsIfDenied:true,);if(result.isSuccessful) {// location permission is granted (or was already granted before making the request)}else {// location permission is not granted// user might have denied, but it's also possible that location service is not enabled, restricted, and user never saw the permission request dialog. Check the result.error.type for details.}

Get the current one-shot location

// get last known location, which is a future rather than a stream (best for android)LocationResult result=awaitGeolocation.lastKnownLocation();// force a single location update (best for ios)StreamSubscription<LocationResult> subscription=Geolocation.currentLocation(accuracy:LocationAccuracy.best).listen((result) {// todo with result});// best option for most casesStreamSubscription<LocationResult> subscription=Geolocation.currentLocation(accuracy:LocationAccuracy.best).listen((result) {if(result.isSuccessful) {Double latitude= result.location.latitude;// todo with result  }});

Continuous location updates

StreamSubscription<LocationResult> subscription=Geolocation.locationUpdates(    accuracy:LocationAccuracy.best,    displacementFilter:10.0,// in meters    inBackground:true,// by default, location updates will pause when app is inactive (in background). Set to `true` to continue updates in background.  )  .listen((result) {if(result.isSuccessful) {// todo with result    }  });// cancelling subscription will also stop the ongoing location requestsubscription.cancel();

Handle location result

LocationResult result=awaitGeolocation.lastKnownLocation();if (result.isSuccessful) {// location request successful, location is guaranteed to not be nulldouble lat= result.location.latitude;double lng= result.location.longitude;}else {switch (result.error.type) {caseGeolocationResultErrorType.runtime:// runtime error, check result.error.messagebreak;caseGeolocationResultErrorType.locationNotFound:// location request did not return any resultbreak;caseGeolocationResultErrorType.serviceDisabled:// location services disabled on device// might be that GPS is turned off, or parental control (android)break;caseGeolocationResultErrorType.permissionNotGranted:// location has not been requested yet// app must request permission in order to access the locationbreak;caseGeolocationResultErrorType.permissionDenied:// user denied the location permission for the app// rejection is final on iOS, and can be on Android if user checks `don't ask again`// user will need to manually allow the app from the settings, see requestLocationPermission(openSettingsIfDenied: true)break;caseGeolocationResultErrorType.playServicesUnavailable:// android only// result.error.additionalInfo contains more details on the play services errorswitch(result.error.additionalInfoasGeolocationAndroidPlayServices) {// do something, like showing a dialog inviting the user to install/update play servicescaseGeolocationAndroidPlayServices.missing:caseGeolocationAndroidPlayServices.updating:caseGeolocationAndroidPlayServices.versionUpdateRequired:caseGeolocationAndroidPlayServices.disabled:caseGeolocationAndroidPlayServices.invalid:      }break;  }}

Authors

Contributers

License