Skip to content

Latest commit

 

History

History
185 lines (141 loc) · 5.81 KB

INSTALL-ANDROID-AUTO.md

File metadata and controls

185 lines (141 loc) · 5.81 KB
Raw

Android Auto-linking Installation

react-native >= 0.60

With yarn

yarn add react-native-background-geolocation
  • For background-geolocation >= 3.6.0:
yarn add react-native-background-fetch@3.1.0
  • For background-geolocation <= 3.5.0
yarn add react-native-background-fetch@2.7.1

With npm

npm install react-native-background-geolocation --save
  • For background-geolocation >= 3.6.0:
npm install react-native-background-fetch@3.1.0 --save
  • For background-geolocation < 3.6.0:
npm install react-native-background-fetch@2.7.1 --save

Configure react-native-background-fetch

You must perform the Android Setup for react-native-background-fetch.

Gradle Configuration

Add the following ext variables to control the version of Google dependency versions the plugin will align to.

ℹ️ You should always strive to use the latest available Google Play Services libraries. You can determine the latest available version here.

In addition, custom maven url for both background-geolocation and background-fetch are required.

📂 android/build.gradle

buildscript {
    ext {
+       googlePlayServicesLocationVersion = "17.0.0"  // Or higher.
        buildToolsVersion = "28.0.3"    // Or higher.
        minSdkVersion = 16
        compileSdkVersion = 28          // Or higher.
        targetSdkVersion = 28           // Or higher.
        supportLibVersion = "1.0.2"     // For pre AndroidX apps.  Not required when using AndroidX
+       appCompatVersion = "1.1.0"      // Or higher.  Required for new AndroidX compatibility.
    }
    ...
}

allprojects {
    repositories {
        mavenLocal()
        maven {
            // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
            url("$rootDir/../node_modules/react-native/android")
        }
        maven {
            // Android JSC is installed from npm
            url("$rootDir/../node_modules/jsc-android/dist")
        }
+       maven {
+           // Required for react-native-background-geolocation
+           url("${project(':react-native-background-geolocation').projectDir}/libs")
+       }
+       maven {
+           // Required for react-native-background-fetch
+           url("${project(':react-native-background-fetch').projectDir}/libs")
+       }
+    }
}

📂 android/app/build.gradle

Background Geolocation requires a gradle extension for your app/build.gradle.

project.ext.react = [
    entryFile: "index.js",
    enableHermes: false,  // clean and rebuild if changing
]

apply from: "../../node_modules/react-native/react.gradle"

+Project background_geolocation = project(':react-native-background-geolocation')
+apply from: "${background_geolocation.projectDir}/app.gradle"

AndroidManifest.xml (License Configuration)

If you've not purchased a license, ignore this step — the plugin is fully functional in DEBUG builds so you can try before you buy.

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.transistorsoft.backgroundgeolocation.react">

  <application
    android:name=".MainApplication"
    android:allowBackup="true"
    android:label="@string/app_name"
    android:icon="@mipmap/ic_launcher"
    android:theme="@style/AppTheme">

    <!-- react-native-background-geolocation licence -->
+   <meta-data android:name="com.transistorsoft.locationmanager.license" android:value="YOUR_LICENCE_KEY_HERE" />
    .
    .
    .
  </application>
</manifest>

Android 10 and When in Use Location Authorization

Android 10 introduces When in Use location authorization. If you're building with compileSdkVersion 29, add the following elements to your AndroidManifest.xml. This allows your app to continue location-tracking when location-services are initiated while your app is in the foreground. For example:

onClickStartTracking() {
    // Initiate tracking while app is in foreground.
    BackgroundGeolocation.changePace(true);
}
<manifest>
    <application>
+       <service android:name="com.transistorsoft.locationmanager.service.TrackingService" android:foregroundServiceType="location" />
+       <service android:name="com.transistorsoft.locationmanager.service.LocationRequestService" android:foregroundServiceType="location" />
    </application>
</manifest>

Proguard Config

If you've enabled def enableProguardInReleaseBuilds = true in your app/build.gradle, be sure to add the BackgroundGeolocation SDK's proguard-rules.pro to your proguardFiles:

📂 android/app/build.gradle)

/**
 * Run Proguard to shrink the Java bytecode in release builds.
 */
def enableProguardInReleaseBuilds = true
.
.
.
android {
    .
    .
    .
    buildTypes {
        release {
            minifyEnabled enableProguardInReleaseBuilds
            proguardFiles getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro"
            // Add following proguardFiles (leave existing one above untouched)
+           proguardFiles "${background_geolocation.projectDir}/proguard-rules.pro"
            signingConfig signingConfigs.release
        }
    }
}

⚠️ If you get error "ERROR: Could not get unknown property 'background_geolocation' for project ':app'", see above and make sure to define the Project background_geolocation.