expo-location 13.0.3 → 14.0.2

package/CHANGELOG.md

@@ -10,14 +10,35 @@
 
 ### 💡 Others
 
-## 13.0.3 — 2021-10-21
+## 14.0.2 — 2022-02-01
 
-_This version does not introduce any user-facing changes._
+### 🐛 Bug fixes
 
-## 13.0.2 — 2021-10-15
+- Fix `Plugin with id 'maven' not found` build error from Android Gradle 7. ([#16080](https://github.com/expo/expo/pull/16080) by [@kudo](https://github.com/kudo))
+
+## 14.0.1 — 2021-12-15
 
 _This version does not introduce any user-facing changes._
 
+## 14.0.0 — 2021-12-03
+
+### 🛠 Breaking changes
+
+- Remove deprecated `setApiKey` method. ([#14672](https://github.com/expo/expo/pull/14672) by [@Simek](https://github.com/Simek))
+
+### 🎉 New features
+
+- Added steetNumber to `reverseGeocodeAsync` for iOS ([#13556](https://github.com/expo/expo/pull/13556) by [@chrisdrackett](https://github.com/chrisdrackett))
+
+### 🐛 Bug fixes
+
+- Call `jobService.jobFinished` for the finished geofencing jobs. ([#14786](https://github.com/expo/expo/pull/14786) by [@mdmitry01](https://github.com/mdmitry01))
+- Check for null value of `mLocationClient` to prevent a crash ([#15023](https://github.com/expo/expo/pull/15023) by [@zakharchenkoAndrii](https://github.com/zakharchenkoAndrii))
+
+### 💡 Others
+
+- Extract nested `foregroundService` object from `LocationTaskOptions` type to the separate type `LocationTaskServiceOptions`. ([#14672](https://github.com/expo/expo/pull/14672) by [@Simek](https://github.com/Simek))
+
 ## 13.0.1 — 2021-10-01
 
 _This version does not introduce any user-facing changes._
@@ -38,6 +59,7 @@ _This version does not introduce any user-facing changes._
 
 - Fixed `Location.getCurrentPositionAsync` throwing `Location provider is unavailable.` error. ([#14281](https://github.com/expo/expo/pull/14281) by [@m1st4ke](https://github.com/m1st4ke))
 - Fix building errors from use_frameworks! in Podfile. ([#14523](https://github.com/expo/expo/pull/14523) by [@kudo](https://github.com/kudo))
+- Update error message for `LocationUnavailableException` on Android. ([#14539](https://github.com/expo/expo/pull/14539) by [@kylerjensen](https://github.com/kylerjensen))
 
 ### 💡 Others
 

package/README.md

@@ -13,7 +13,7 @@ For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-
 
 # Installation in bare React Native projects
 
-For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/expo/expo/tree/master/packages/react-native-unimodules) before continuing.
+For bare React Native projects, you must ensure that you have [installed and configured the `expo` package](https://docs.expo.dev/bare/installing-expo-modules/) before continuing.
 
 ### Add the package to your npm dependencies
 

package/android/build.gradle

@@ -1,9 +1,9 @@
 apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
-apply plugin: 'maven'
+apply plugin: 'maven-publish'
 
 group = 'host.exp.exponent'
-version = '13.0.3'
+version = '14.0.2'
 
 buildscript {
   // Simple helper that allows the root project to override versions declared by this library.
@@ -20,27 +20,25 @@ buildscript {
   }
 }
 
-// Upload android library to maven with javadoc and android sources
-configurations {
-  deployerJars
-}
-
 // Creating sources with comments
 task androidSourcesJar(type: Jar) {
   classifier = 'sources'
   from android.sourceSets.main.java.srcDirs
 }
 
-// Put the androidSources and javadoc to the artifacts
-artifacts {
-  archives androidSourcesJar
-}
-
-uploadArchives {
-  repositories {
-    mavenDeployer {
-      configuration = configurations.deployerJars
-      repository(url: mavenLocal().url)
+afterEvaluate {
+  publishing {
+    publications {
+      release(MavenPublication) {
+        from components.release
+        // Add additional sourcesJar to artifacts
+        artifact(androidSourcesJar)
+      }
+    }
+    repositories {
+      maven {
+        url = mavenLocal().url
+      }
     }
   }
 }
@@ -57,7 +55,7 @@ android {
     minSdkVersion safeExtGet("minSdkVersion", 21)
     targetSdkVersion safeExtGet("targetSdkVersion", 30)
     versionCode 29
-    versionName "13.0.3"
+    versionName "14.0.2"
   }
   lintOptions {
     abortOnError false

package/android/src/main/java/expo/modules/location/LocationHelpers.java

@@ -96,6 +96,7 @@ public class LocationHelpers {
 
     map.putString("city", address.getLocality());
     map.putString("district", address.getSubLocality());
+    map.putString("streetNumber", address.getSubThoroughfare());
     map.putString("street", address.getThoroughfare());
     map.putString("region", address.getAdminArea());
     map.putString("subregion", address.getSubAdminArea());

package/android/src/main/java/expo/modules/location/exceptions/LocationUnavailableException.java

@@ -5,7 +5,7 @@ import expo.modules.core.errors.CodedException;
 
 public class LocationUnavailableException extends CodedException implements CodedThrowable {
   public LocationUnavailableException() {
-    super("Location provider is unavailable. Make sure that location services are enabled.");
+    super("Location is unavailable. Make sure that location services are enabled.");
   }
 
   @Override

package/android/src/main/java/expo/modules/location/taskConsumers/GeofencingTaskConsumer.java

@@ -26,6 +26,7 @@ import java.util.UUID;
 import org.unimodules.interfaces.taskManager.TaskConsumer;
 import org.unimodules.interfaces.taskManager.TaskManagerUtilsInterface;
 import org.unimodules.interfaces.taskManager.TaskConsumerInterface;
+import org.unimodules.interfaces.taskManager.TaskExecutionCallback;
 import org.unimodules.interfaces.taskManager.TaskInterface;
 import expo.modules.location.LocationHelpers;
 import expo.modules.location.LocationModule;
@@ -135,8 +136,16 @@ public class GeofencingTaskConsumer extends TaskConsumer implements TaskConsumer
       if (mTask == null) {
         return false;
       }
-      mTask.execute(bundle, null);
+      mTask.execute(bundle, null, new TaskExecutionCallback() {
+        @Override
+        public void onFinished(Map<String, Object> response) {
+          jobService.jobFinished(params, false);
+        }
+      });
     }
+
+    // Returning `true` indicates that the job is still running, but in async mode.
+    // In that case we're obligated to call `jobService.jobFinished` as soon as the async block finishes.
     return true;
   }
 

package/android/src/main/java/expo/modules/location/taskConsumers/LocationTaskConsumer.java

@@ -111,6 +111,10 @@ public class LocationTaskConsumer extends TaskConsumer implements TaskConsumerIn
       maybeReportDeferredLocations();
     } else {
       try {
+        if(mLocationClient == null){
+          Log.w(TAG, "LocationClient is null.");
+          return;
+        }
         mLocationClient.getLastLocation().addOnCompleteListener(new OnCompleteListener<Location>() {
           @Override
           public void onComplete(@NonNull Task<Location> task) {

package/build/GeolocationPolyfill.d.ts

@@ -1 +1,4 @@
+/**
+ * Polyfills `navigator.geolocation` for interop with the core React Native and Web API approach to geolocation.
+ */
 export declare function installWebGeolocationPolyfill(): void;

package/build/GeolocationPolyfill.js

@@ -2,10 +2,12 @@ import { Platform } from 'expo-modules-core';
 import ExpoLocation from './ExpoLocation';
 import { LocationAccuracy } from './Location.types';
 import { LocationSubscriber } from './LocationSubscribers';
+// @needsAudit
+/**
+ * Polyfills `navigator.geolocation` for interop with the core React Native and Web API approach to geolocation.
+ */
 export function installWebGeolocationPolyfill() {
     if (Platform.OS !== 'web') {
-        // Polyfill navigator.geolocation for interop with the core react-native and web API approach to
-        // geolocation
         // @ts-ignore
         window.navigator.geolocation = {
             getCurrentPosition,

package/build/GeolocationPolyfill.js.map

@@ -1 +1 @@
-{"version":3,"file":"GeolocationPolyfill.js","sourceRoot":"","sources":["../src/GeolocationPolyfill.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAkB,gBAAgB,EAAmB,MAAM,kBAAkB,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAS3D,MAAM,UAAU,6BAA6B;IAC3C,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK,EAAE;QACzB,gGAAgG;QAChG,cAAc;QACd,aAAa;QACb,MAAM,CAAC,SAAS,CAAC,WAAW,GAAG;YAC7B,kBAAkB;YAClB,aAAa;YACb,UAAU;YAEV,kGAAkG;YAClG,uBAAuB;YACvB,aAAa,EAAE,GAAG,EAAE,GAAE,CAAC;SACxB,CAAC;KACH;AACH,CAAC;AAED,SAAS,yBAAyB,CAAC,OAA2B;IAC5D,OAAO;QACL,QAAQ,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,gBAAgB,CAAC,QAAQ;KACzF,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CACzB,OAAmC,EACnC,QAAkC,GAAG,EAAE,GAAE,CAAC,EAC1C,UAA8B,EAAE;IAEhC,+BAA+B,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AAC3D,CAAC;AAED,mGAAmG;AACnG,0DAA0D;AAC1D,KAAK,UAAU,+BAA+B,CAC5C,OAAmC,EACnC,KAA+B,EAC/B,OAA2B;IAE3B,IAAI;QACF,MAAM,YAAY,CAAC,uBAAuB,EAAE,CAAC;QAC7C,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,uBAAuB,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC;QAC9F,OAAO,CAAC,MAAM,CAAC,CAAC;KACjB;IAAC,OAAO,CAAC,EAAE;QACV,KAAK,CAAC,CAAC,CAAC,CAAC;KACV;AACH,CAAC;AAED,gDAAgD;AAChD,SAAS,aAAa,CACpB,OAAmC,EACnC,KAA+B,EAC/B,OAA2B;IAE3B,MAAM,OAAO,GAAG,kBAAkB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAE7D,YAAY,CAAC,sBAAsB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QAClE,kBAAkB,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC/C,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,6CAA6C;AAC7C,SAAS,UAAU,CAAC,OAAe;IACjC,kBAAkB,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;AACjD,CAAC","sourcesContent":["import { Platform } from 'expo-modules-core';\n\nimport ExpoLocation from './ExpoLocation';\nimport { LocationObject, LocationAccuracy, LocationOptions } from './Location.types';\nimport { LocationSubscriber } from './LocationSubscribers';\n\ntype GeolocationSuccessCallback = (data: LocationObject) => void;\ntype GeolocationErrorCallback = (error: any) => void;\n\ntype GeolocationOptions = {\n  enableHighAccuracy?: boolean;\n};\n\nexport function installWebGeolocationPolyfill(): void {\n  if (Platform.OS !== 'web') {\n    // Polyfill navigator.geolocation for interop with the core react-native and web API approach to\n    // geolocation\n    // @ts-ignore\n    window.navigator.geolocation = {\n      getCurrentPosition,\n      watchPosition,\n      clearWatch,\n\n      // We don't polyfill stopObserving, this is an internal method that probably should not even exist\n      // in react-native docs\n      stopObserving: () => {},\n    };\n  }\n}\n\nfunction convertGeolocationOptions(options: GeolocationOptions): LocationOptions {\n  return {\n    accuracy: options.enableHighAccuracy ? LocationAccuracy.High : LocationAccuracy.Balanced,\n  };\n}\n\nfunction getCurrentPosition(\n  success: GeolocationSuccessCallback,\n  error: GeolocationErrorCallback = () => {},\n  options: GeolocationOptions = {}\n): void {\n  _getCurrentPositionAsyncWrapper(success, error, options);\n}\n\n// This function exists to let us continue to return undefined from getCurrentPosition, while still\n// using async/await for the internal implementation of it\nasync function _getCurrentPositionAsyncWrapper(\n  success: GeolocationSuccessCallback,\n  error: GeolocationErrorCallback,\n  options: GeolocationOptions\n): Promise<any> {\n  try {\n    await ExpoLocation.requestPermissionsAsync();\n    const result = await ExpoLocation.getCurrentPositionAsync(convertGeolocationOptions(options));\n    success(result);\n  } catch (e) {\n    error(e);\n  }\n}\n\n// Polyfill: navigator.geolocation.watchPosition\nfunction watchPosition(\n  success: GeolocationSuccessCallback,\n  error: GeolocationErrorCallback,\n  options: GeolocationOptions\n) {\n  const watchId = LocationSubscriber.registerCallback(success);\n\n  ExpoLocation.watchPositionImplAsync(watchId, options).catch((err) => {\n    LocationSubscriber.unregisterCallback(watchId);\n    error({ watchId, message: err.message, code: err.code });\n  });\n\n  return watchId;\n}\n\n// Polyfill: navigator.geolocation.clearWatch\nfunction clearWatch(watchId: number) {\n  LocationSubscriber.unregisterCallback(watchId);\n}\n"]}
+{"version":3,"file":"GeolocationPolyfill.js","sourceRoot":"","sources":["../src/GeolocationPolyfill.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAkB,gBAAgB,EAAmB,MAAM,kBAAkB,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAS3D,cAAc;AACd;;GAEG;AACH,MAAM,UAAU,6BAA6B;IAC3C,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK,EAAE;QACzB,aAAa;QACb,MAAM,CAAC,SAAS,CAAC,WAAW,GAAG;YAC7B,kBAAkB;YAClB,aAAa;YACb,UAAU;YAEV,kGAAkG;YAClG,uBAAuB;YACvB,aAAa,EAAE,GAAG,EAAE,GAAE,CAAC;SACxB,CAAC;KACH;AACH,CAAC;AAED,SAAS,yBAAyB,CAAC,OAA2B;IAC5D,OAAO;QACL,QAAQ,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,gBAAgB,CAAC,QAAQ;KACzF,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CACzB,OAAmC,EACnC,QAAkC,GAAG,EAAE,GAAE,CAAC,EAC1C,UAA8B,EAAE;IAEhC,+BAA+B,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AAC3D,CAAC;AAED,mGAAmG;AACnG,0DAA0D;AAC1D,KAAK,UAAU,+BAA+B,CAC5C,OAAmC,EACnC,KAA+B,EAC/B,OAA2B;IAE3B,IAAI;QACF,MAAM,YAAY,CAAC,uBAAuB,EAAE,CAAC;QAC7C,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,uBAAuB,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC;QAC9F,OAAO,CAAC,MAAM,CAAC,CAAC;KACjB;IAAC,OAAO,CAAC,EAAE;QACV,KAAK,CAAC,CAAC,CAAC,CAAC;KACV;AACH,CAAC;AAED,gDAAgD;AAChD,SAAS,aAAa,CACpB,OAAmC,EACnC,KAA+B,EAC/B,OAA2B;IAE3B,MAAM,OAAO,GAAG,kBAAkB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAE7D,YAAY,CAAC,sBAAsB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QAClE,kBAAkB,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC/C,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,6CAA6C;AAC7C,SAAS,UAAU,CAAC,OAAe;IACjC,kBAAkB,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;AACjD,CAAC","sourcesContent":["import { Platform } from 'expo-modules-core';\n\nimport ExpoLocation from './ExpoLocation';\nimport { LocationObject, LocationAccuracy, LocationOptions } from './Location.types';\nimport { LocationSubscriber } from './LocationSubscribers';\n\ntype GeolocationSuccessCallback = (data: LocationObject) => void;\ntype GeolocationErrorCallback = (error: any) => void;\n\ntype GeolocationOptions = {\n  enableHighAccuracy?: boolean;\n};\n\n// @needsAudit\n/**\n * Polyfills `navigator.geolocation` for interop with the core React Native and Web API approach to geolocation.\n */\nexport function installWebGeolocationPolyfill(): void {\n  if (Platform.OS !== 'web') {\n    // @ts-ignore\n    window.navigator.geolocation = {\n      getCurrentPosition,\n      watchPosition,\n      clearWatch,\n\n      // We don't polyfill stopObserving, this is an internal method that probably should not even exist\n      // in react-native docs\n      stopObserving: () => {},\n    };\n  }\n}\n\nfunction convertGeolocationOptions(options: GeolocationOptions): LocationOptions {\n  return {\n    accuracy: options.enableHighAccuracy ? LocationAccuracy.High : LocationAccuracy.Balanced,\n  };\n}\n\nfunction getCurrentPosition(\n  success: GeolocationSuccessCallback,\n  error: GeolocationErrorCallback = () => {},\n  options: GeolocationOptions = {}\n): void {\n  _getCurrentPositionAsyncWrapper(success, error, options);\n}\n\n// This function exists to let us continue to return undefined from getCurrentPosition, while still\n// using async/await for the internal implementation of it\nasync function _getCurrentPositionAsyncWrapper(\n  success: GeolocationSuccessCallback,\n  error: GeolocationErrorCallback,\n  options: GeolocationOptions\n): Promise<any> {\n  try {\n    await ExpoLocation.requestPermissionsAsync();\n    const result = await ExpoLocation.getCurrentPositionAsync(convertGeolocationOptions(options));\n    success(result);\n  } catch (e) {\n    error(e);\n  }\n}\n\n// Polyfill: navigator.geolocation.watchPosition\nfunction watchPosition(\n  success: GeolocationSuccessCallback,\n  error: GeolocationErrorCallback,\n  options: GeolocationOptions\n) {\n  const watchId = LocationSubscriber.registerCallback(success);\n\n  ExpoLocation.watchPositionImplAsync(watchId, options).catch((err) => {\n    LocationSubscriber.unregisterCallback(watchId);\n    error({ watchId, message: err.message, code: err.code });\n  });\n\n  return watchId;\n}\n\n// Polyfill: navigator.geolocation.clearWatch\nfunction clearWatch(watchId: number) {\n  LocationSubscriber.unregisterCallback(watchId);\n}\n"]}

package/build/Location.d.ts

@@ -3,62 +3,110 @@ import { LocationAccuracy, LocationCallback, LocationGeocodedAddress, LocationGe
 import { LocationEventEmitter } from './LocationEventEmitter';
 import { setGoogleApiKey } from './LocationGoogleGeocoding';
 import { _getCurrentWatchId } from './LocationSubscribers';
+/**
+ * Check status of location providers.
+ * @return A promise which fulfills with an object of type [LocationProviderStatus](#locationproviderstatus).
+ */
 export declare function getProviderStatusAsync(): Promise<LocationProviderStatus>;
+/**
+ * Asks the user to turn on high accuracy location mode which enables network provider that uses
+ * Google Play services to improve location accuracy and location-based services.
+ * @return A promise resolving as soon as the user accepts the dialog. Rejects if denied.
+ */
 export declare function enableNetworkProviderAsync(): Promise<void>;
 /**
  * Requests for one-time delivery of the user's current location.
  * Depending on given `accuracy` option it may take some time to resolve,
  * especially when you're inside a building.
+ * > __Note:__ Calling it causes the location manager to obtain a location fix which may take several
+ * > seconds. Consider using [`Location.getLastKnownPositionAsync`](#locationgetlastknownpositionasyncoptions)
+ * > if you expect to get a quick response and high accuracy is not required.
+ * @param options
+ * @return A promise which fulfills with an object of type [`LocationObject`](#locationobject).
  */
 export declare function getCurrentPositionAsync(options?: LocationOptions): Promise<LocationObject>;
 /**
- * Gets the last known position of the device or `null` if it's not available
- * or doesn't match given requirements such as maximum age or required accuracy.
- * It's considered to be faster than `getCurrentPositionAsync` as it doesn't request for the current location.
+ * Gets the last known position of the device or `null` if it's not available or doesn't match given
+ * requirements such as maximum age or required accuracy.
+ * It's considered to be faster than `getCurrentPositionAsync` as it doesn't request for the current
+ * location, but keep in mind the returned location may not be up-to-date.
+ * @param options
+ * @return A promise which fulfills with an object of type [LocationObject](#locationobject) or
+ * `null` if it's not available or doesn't match given requirements such as maximum age or required
+ * accuracy.
  */
 export declare function getLastKnownPositionAsync(options?: LocationLastKnownOptions): Promise<LocationObject | null>;
 /**
- * Starts watching for location changes.
- * Given callback will be called once the new location is available.
+ * Subscribe to location updates from the device. Please note that updates will only occur while the
+ * application is in the foreground. To get location updates while in background you'll need to use
+ * [Location.startLocationUpdatesAsync](#locationstartlocationupdatesasynctaskname-options).
+ * @param options
+ * @param callback This function is called on each location update. It receives an object of type
+ * [`LocationObject`](#locationobject) as the first argument.
+ * @return A promise which fulfills with a [`LocationSubscription`](#locationsubscription) object.
  */
-export declare function watchPositionAsync(options: LocationOptions, callback: LocationCallback): Promise<{
-    remove(): void;
-}>;
+export declare function watchPositionAsync(options: LocationOptions, callback: LocationCallback): Promise<LocationSubscription>;
 /**
- * Resolves to an object with current heading details.
- * To simplify, it calls `watchHeadingAsync` and waits for a couple of updates
- * and returns the one that is accurate enough.
+ * Gets the current heading information from the device. To simplify, it calls `watchHeadingAsync`
+ * and waits for a couple of updates, and then returns the one that is accurate enough.
+ * @return A promise which fulfills with an object of type [LocationHeadingObject](#locationheadingobject).
  */
 export declare function getHeadingAsync(): Promise<LocationHeadingObject>;
 /**
- * Starts watching for heading changes.
- * Given callback will be called once the new heading is available.
+ * Subscribe to compass updates from the device.
+ * @param callback This function is called on each compass update. It receives an object of type
+ * [LocationHeadingObject](#locationheadingobject) as the first argument.
+ * @return A promise which fulfills with a [`LocationSubscription`](#locationsubscription) object.
  */
 export declare function watchHeadingAsync(callback: LocationHeadingCallback): Promise<LocationSubscription>;
 /**
- * Geocodes given address to an array of latitude-longitude coordinates.
+ * Geocode an address string to latitude-longitude location.
+ * > **Note**: Geocoding is resource consuming and has to be used reasonably. Creating too many
+ * > requests at a time can result in an error, so they have to be managed properly.
+ * > It's also discouraged to use geocoding while the app is in the background and its results won't
+ * > be shown to the user immediately.
+ *
+ * > On Android, you must request a location permission (`Permissions.LOCATION`) from the user
+ * > before geocoding can be used.
+ * @param address A string representing address, eg. `"Baker Street London"`.
+ * @param options
+ * @return A promise which fulfills with an array (in most cases its size is 1) of [`LocationGeocodedLocation`](#locationgeocodedlocation) objects.
  */
 export declare function geocodeAsync(address: string, options?: LocationGeocodingOptions): Promise<LocationGeocodedLocation[]>;
 /**
- * The opposite behavior of `geocodeAsync` — translates location coordinates to an array of addresses.
+ * Reverse geocode a location to postal address.
+ * > **Note**: Geocoding is resource consuming and has to be used reasonably. Creating too many
+ * > requests at a time can result in an error, so they have to be managed properly.
+ * > It's also discouraged to use geocoding while the app is in the background and its results won't
+ * > be shown to the user immediately.
+ *
+ * > On Android, you must request a location permission (`Permissions.LOCATION`) from the user
+ * > before geocoding can be used.
+ * @param location An object representing a location.
+ * @param options
+ * @return A promise which fulfills with an array (in most cases its size is 1) of [`LocationGeocodedAddress`](#locationgeocodedaddress) objects.
  */
 export declare function reverseGeocodeAsync(location: Pick<LocationGeocodedLocation, 'latitude' | 'longitude'>, options?: LocationGeocodingOptions): Promise<LocationGeocodedAddress[]>;
 /**
- * Gets the current state of location permissions.
- * @deprecated Use `getForegroundPermissionsAsync()` or `getBackgroundPermissionsAsync()` instead.
+ * Checks user's permissions for accessing location.
+ * @return A promise that fulfills with an object of type [LocationPermissionResponse](#locationpermissionresponse).
+ * @deprecated __Deprecated.__ Use [`getForegroundPermissionsAsync`](#locationgetforegroundpermissionsasync) or [`getBackgroundPermissionsAsync`](#locationgetbackgroundpermissionsasync) instead.
  */
 export declare function getPermissionsAsync(): Promise<LocationPermissionResponse>;
 /**
- * Requests the user to grant location permissions.
- * @deprecated Use `requestForegroundPermissionsAsync()` or `requestBackgroundPermissionsAsync()` instead.
+ * Asks the user to grant permissions for location.
+ * @return A promise that fulfills with an object of type [LocationPermissionResponse](#locationpermissionresponse).
+ * @deprecated __Deprecated.__ Use [`requestForegroundPermissionsAsync`](#locationrequestforegroundpermissionsasync) or [`requestBackgroundPermissionsAsync`](#locationrequestbackgroundpermissionsasync) instead.
  */
 export declare function requestPermissionsAsync(): Promise<LocationPermissionResponse>;
 /**
- * Gets the current state of foreground location permissions.
+ * Checks user's permissions for accessing location while the app is in the foreground.
+ * @return A promise that fulfills with an object of type [PermissionResponse](#permissionresponse).
  */
 export declare function getForegroundPermissionsAsync(): Promise<LocationPermissionResponse>;
 /**
- * Requests the user to grant foreground location permissions.
+ * Asks the user to grant permissions for location while the app is in the foreground.
+ * @return A promise that fulfills with an object of type [PermissionResponse](#permissionresponse).
  */
 export declare function requestForegroundPermissionsAsync(): Promise<LocationPermissionResponse>;
 /**
@@ -72,16 +120,24 @@ export declare function requestForegroundPermissionsAsync(): Promise<LocationPer
  */
 export declare const useForegroundPermissions: (options?: PermissionHookOptions<object> | undefined) => [LocationPermissionResponse | null, () => Promise<LocationPermissionResponse>, () => Promise<LocationPermissionResponse>];
 /**
- * Gets the current state of background location permissions.
+ * Checks user's permissions for accessing location while the app is in the background.
+ * @return A promise that fulfills with an object of type [PermissionResponse](#permissionresponse).
  */
 export declare function getBackgroundPermissionsAsync(): Promise<PermissionResponse>;
 /**
- * Requests the user to grant background location permissions.
+ * Asks the user to grant permissions for location while the app is in the background.
+ * On __Android 11 or higher__: this method will open the system settings page - before that happens
+ * you should explain to the user why your application needs background location permission.
+ * For example, you can use `Modal` component from `react-native` to do that.
+ * > __Note__: Foreground permissions should be granted before asking for the background permissions
+ * (your app can't obtain background permission without foreground permission).
+ * @return A promise that fulfills with an object of type [PermissionResponse](#permissionresponse).
  */
 export declare function requestBackgroundPermissionsAsync(): Promise<PermissionResponse>;
 /**
  * Check or request permissions for the foreground location.
- * This uses both `requestBackgroundPermissionsAsync` and `getBackgroundPermissionsAsync` to interact with the permissions.
+ * This uses both `requestBackgroundPermissionsAsync` and `getBackgroundPermissionsAsync` to
+ * interact with the permissions.
  *
  * @example
  * ```ts
@@ -90,21 +146,96 @@ export declare function requestBackgroundPermissionsAsync(): Promise<PermissionR
  */
 export declare const useBackgroundPermissions: (options?: PermissionHookOptions<object> | undefined) => [PermissionResponse | null, () => Promise<PermissionResponse>, () => Promise<PermissionResponse>];
 /**
- * Returns `true` if the device has location services enabled or `false` otherwise.
+ * Checks whether location services are enabled by the user.
+ * @return A promise which fulfills to `true` if location services are enabled on the device,
+ * or `false` if not.
  */
 export declare function hasServicesEnabledAsync(): Promise<boolean>;
 export declare function isBackgroundLocationAvailableAsync(): Promise<boolean>;
+/**
+ * Registers for receiving location updates that can also come when the app is in the background.
+ * @param taskName Name of the task receiving location updates.
+ * @param options An object of options passed to the location manager.
+ * @return A promise resolving once the task with location updates is registered.
+ *
+ * # Task parameters
+ *
+ * Background location task will be receiving following data:
+ * - `locations` - An array of the new locations.
+ *
+ * ```ts
+ * import * as TaskManager from 'expo-task-manager';
+ *
+ * TaskManager.defineTask(YOUR_TASK_NAME, ({ data: { locations }, error }) => {
+ *  if (error) {
+ *    // check `error.message` for more details.
+ *    return;
+ *  }
+ *  console.log('Received new locations', locations);
+ * });
+ * ```
+ */
 export declare function startLocationUpdatesAsync(taskName: string, options?: LocationTaskOptions): Promise<void>;
+/**
+ * Stops geofencing for specified task.
+ * @param taskName Name of the background location task to stop.
+ * @return A promise resolving as soon as the task is unregistered.
+ */
 export declare function stopLocationUpdatesAsync(taskName: string): Promise<void>;
+/**
+ * @param taskName Name of the location task to check.
+ * @return A promise which fulfills with boolean value indicating whether the location task is
+ * started or not.
+ */
 export declare function hasStartedLocationUpdatesAsync(taskName: string): Promise<boolean>;
+/**
+ * Starts geofencing for given regions. When the new event comes, the task with specified name will
+ * be called with the region that the device enter to or exit from.
+ * If you want to add or remove regions from already running geofencing task, you can just call
+ * `startGeofencingAsync` again with the new array of regions.
+ * @param taskName Name of the task that will be called when the device enters or exits from specified regions.
+ * @param regions Array of region objects to be geofenced.
+ * @return A promise resolving as soon as the task is registered.
+ *
+ * # Task parameters
+ *
+ * Geofencing task will be receiving following data:
+ *  - `eventType` - Indicates the reason for calling the task, which can be triggered by entering or exiting the region.
+ *    See [GeofencingEventType](#geofencingeventtype).
+ *  - `region` - Object containing details about updated region. See [LocationRegion](#locationregion) for more details.
+ *
+ * # Example
+ * ```ts
+ * import { GeofencingEventType } from 'expo-location';
+ * import * as TaskManager from 'expo-task-manager';
+ *
+ *  TaskManager.defineTask(YOUR_TASK_NAME, ({ data: { eventType, region }, error }) => {
+ *   if (error) {
+ *     // check `error.message` for more details.
+ *     return;
+ *   }
+ *   if (eventType === GeofencingEventType.Enter) {
+ *     console.log("You've entered region:", region);
+ *   } else if (eventType === GeofencingEventType.Exit) {
+ *     console.log("You've left region:", region);
+ *   }
+ * });
+ * ```
+ */
 export declare function startGeofencingAsync(taskName: string, regions?: LocationRegion[]): Promise<void>;
+/**
+ * Stops geofencing for specified task. It unregisters the background task so the app will not be
+ * receiving any updates, especially in the background.
+ * @param taskName Name of the task to unregister.
+ * @return A promise resolving as soon as the task is unregistered.
+ */
 export declare function stopGeofencingAsync(taskName: string): Promise<void>;
-export declare function hasStartedGeofencingAsync(taskName: string): Promise<boolean>;
 /**
- * @deprecated
- * Deprecated as of SDK39 in favour of `setGoogleApiKey`.
+ * @param taskName Name of the geofencing task to check.
+ * @return A promise which fulfills with boolean value indicating whether the geofencing task is
+ * started or not.
  */
-export declare function setApiKey(apiKey: string): void;
+export declare function hasStartedGeofencingAsync(taskName: string): Promise<boolean>;
 export { LocationEventEmitter as EventEmitter, _getCurrentWatchId };
 export { LocationAccuracy as Accuracy, LocationActivityType as ActivityType, LocationGeofencingEventType as GeofencingEventType, LocationGeofencingRegionState as GeofencingRegionState, PermissionStatus, PermissionHookOptions, setGoogleApiKey, };
 export { installWebGeolocationPolyfill } from './GeolocationPolyfill';