@mobeye/geolocation v1.0.0

React Native Mobeye Geolocation

React Native Geolocation API for Android and iOS. It allows to get geolocation as well in background as in foreground.

Table of Contents

• React Native Mobeye Geolocation
  • Getting started
  • General Usage
  • API
  • Example

Getting started

Install the library using Yarn:

yarn add react-native-mobeye-geolocation

General Usage

import React, { useEffect, useState, useRef } from 'react';
import { View, Text } from 'react-native';
import Geolocation, { useLocation } from 'react-native-mobeye-geolocation';

export const App = () => {
  const [permission, setPermission] = useState(false);
  const prevPermission = useRef(false)
  const location = useLocation();
  
  useEffect(() => {
    Geolocation.configuration(10, 500, "BalancedPower")
    if (Platform.OS === 'ios') {
      Geolocation.checkIOSAuthorization().then((res) => {
        setPermission(res);
      });
    } else {
      PermissionsAndroid.check('android.permission.ACCESS_FINE_LOCATION').then((res) => {
         setPermission(res);
      });
    }
  }, [])
 
  useEffect(() => {
    if (!prevPermission.current && permission) {
      Geolocation.start();
    }
    prevPermission.current = permission;
  }, [permission]);
  
  return (
    <View>
      <Text>Latitude: {location.latitude.toString()}</Text>
      <Text>Longitude: {location.longitude.toString()}</Text>
      <Text>Accuracy: {location.accuracy.toString()}</Text>
    </View>
  );
};

API

• Types:
  • AccuracyLevel
  • LocationConfiguration
  • Location
  • Errors
• Methods:
  • configure()
  • start()
  • useLocation()
  • setTemporaryConfiguration()
  • revertTemporaryConfiguration()
  • checkIOSauthorization()
  • requestIOSauthorization()

Types

LocationConfiguration

The configuration options for the library:

AccuracyLevel

Describes different accuracy level available:

Note that the NavigationAccuracy and BestAccuracy have the same effect on Android and that NavigationAccuracy is usable only if the phone is plugged in.

Location

Describe a computed location:

Errors

You can encounter some errors that are described in this table:

Methods

configure()

Configure the library with the given configuration and instantiate the provider service. You only need to supply the properties you want to change from the default values. Any other methods will not work if the service is not instantiated. This method can be called only once.

Example:

Geolocation.configure({
  distanceFilter: 100,
  desiredAccuracy: 'BalancedPower',
  bufferSize: 10
});

start()

Start the service using options defined with configure(). The module sends a 'LOCATION_UPDATED' event when a new computed location has changed significantly. Locations are also computed in background.

Example:

Geolocation.start();

useLocation()

A React Hook which can be used to get access to the last computed location and to follow updates when the location significantly changes. It returns a hook with the Location type.

Example:

import { useLocation } from 'react-native-mobeye-geolocation';

const YourComponent = () => {
  const location = useLocation();
    
  return (
    <View>
      <Text>Latitude: {location.latitude.toString()}</Text>
      <Text>Longitude: {location.longitude.toString()}</Text>
      <Text>Accuracy: {location.accuracy.toString()}</Text>
    </View>
  )
}

getLastLocations()

Return a Promise that gets last locations saved in the buffer. You can optionally send a number of locations you need to retrieve. Without number, the method returns all saved locations in the buffer.

Example:

Geolocation.getLastLocation(10).then(locations => {
  const lastLocation = locations[0];
  console.log("Latitude", lastLocation.latitude);
  console.log("Longitude", lastLocation.longitude);
})

setTemporaryConfiguration()

Sometime you may need to temporary change the accuracy level to have a better user tracking. This method changes on the fly your configuration (except the buffer size).

Example:

Geolocation.setTemporaryConfiguration({
  distanceFilter: 20,
  desiredAccuracy: "BestAccuracy"
})

revertTemporaryConfiguration()

Reset configuration with the LocationConfiguration used with configure().

Example

Geolocation.resetTemporaryConfiguration();

checkIOSAuthorization()

Return a Promise that gets the location permission status as boolean for ios. For android, you can use PermissionAndroid.

Example:

import { useEffect } from 'react';
import { Platform } from 'react-native';
import Geolocation from 'react-native-mobeye-geolocation';

const YourComponent = () => {
  const [permission, setPermission] =  useState(false);

  useEffect(() => {
    Geolocation.configure();
    if (Platform.OS === 'ios') {
        Geolocation.checkIOSAuthorization().then(status => setPermission(status))
    }
  },  [])    

  return (
    <View>
      <Text>Do you have permission?  {permission.toString()}</Text>
    </View>
  )
}

:warning: In the futur, Apple may add new authorizations. In this case, the Promise will be rejected with the code error 5. Do not hesitate to create a pull request to add the new authorization.

requestIOSAuthorization()

Requests the geolocation permission for ios. Returns a Promise that resolves to a PermissionStatus. configure must be called before this method since the service will start on its own if the user set the geolocation permission.

import { useEffect } from 'react';
import { Platform, PermissionStatus } from 'react-native';
import Geolocation from 'react-native-mobeye-geolocation';

const YourComponent = () => {
  const [status, setStatus] = useEffect(PermissionStatus.denied); 
    
  useEffect(() => {
    if (Platform.OS === 'ios') {
      Geolocation.requestIOSAuthorization().then(status => setStatus(status))
    }
  }, [])

  return (
    <View>
      <Text>Do you have permission ? {status}</Text>
    </View>
  )
}

Example

You can run a simple example present in the module to test the geolocation. First, you need to install node_modules and example pods:

yarn && cd example/ios/ && pod install && cd - && yarn start

Then, open the example directory with xcode or android studio to build the example.