View on GitHub

@nativescript/geolocation ​

Contents ​

• Intro
• Installation
• Android permissions requirements
• iOS permissions requirements
• Use @nativescript/geolocation
  • Get current location
• API
  • Plugin functions
  • Location class
  • Options interface
• Known Issues
  • Version conflicts with Google Play Services
  • openSettingsIfLocationHasBeenDenied on Android API level 30

Intro ​

A geolocation plugin to use for getting current location, monitor movement, etc.

Installation ​

To install the plugin, run the following command in the root of your project.

npm install @nativescript/geolocation

Android permissions requirements ​

To use geolocation on Android, you need to add the following permissions to your app's AndroidManifest.xml inside the App_Resources/Android/src/main directory:

<!-- Always include this permission -->
  <!-- This permission is for "approximate" location data -->
  <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />

  <!-- Include only if your app benefits from precise location access. -->
  <!-- This permission is for "precise" location data -->
  <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

  <!-- Required only when requesting background location access on
       Android 10 (API level 29) and higher. -->
  <uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />

More information can be found in the Android docs here.

iOS permissions requirements ​

If iosAllowsBackgroundLocationUpdates property of the options object is set to true, the following code is required in the App_Resources/iOS/Info.plist file:

<key>UIBackgroundModes</key>
<array>
  <string>location</string>
</array>

Use @nativescript/geolocation ​

Get current location ​

Before you call any method that gets the user's location, request for the user's permission by calling the enableLocationRequest method. Once the user has granted the permission, you can call the getCurrentLocation() method, passing it a options object to get the user's current location.

import * as geolocation from '@nativescript/geolocation'
import { CoreTypes } from '@nativescript/core' // used to describe at what accuracy the location should get

geolocation.enableLocationRequest().then(() => {
  geolocation
    .getCurrentLocation({
      desiredAccuracy: CoreTypes.Accuracy.high,
      maximumAge: 5000,
      timeout: 20000,
    })
    .then((currentLocation) => {
      console.log('My current latitude: ', currentLocation.latitude)
    })
})

API ​

Plugin functions ​

The plugin provides the following functions for getting current location and more:

Location class ​

This is a data class that encapsulates the following common properties for a geolocation.

Options interface ​

The following are the properties of the options object that you pass to the geolocation functions of the plugin.

Known issues ​

openSettingsIfLocationHasBeenDenied on Android API level 30 ​

If the user declines the permission twice during the installation lifetime of the app on Android API level 30 , the user won't be taken to the settings even if the openSettingsIfLocationHasBeenDenied option is true for enableLocationRequest().

License ​

Apache License Version 2.0