Package Exports
- @hmscore/react-native-hms-location
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@hmscore/react-native-hms-location) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
react-native-hms-location
Table of contents
Introduction
The React-Native SDK code encapsulates the Huawei location client interface. It provides many APIs for your reference or use.
The React-Native SDK code package is described as follows:
- Android: core layer, bridging Location SDK bottom-layer code;
- src/modules: Android interface layer, which is used to parse the received data, send requests and generate class instances.
- index.js: external interface definition layer, which is used to define interface classes or reference files.
Installation Guide
Before using Reactive-Native SDK code, ensure that the RN development environment has been installed.
Add Maven Repository
- Add maven repository address into 'android/build.gradle' file.
maven {url 'https://developer.huawei.com/repo/'}Plugin Integration
The plugin can be added to the project using npm or download link.
Using Npm
npm install @hmscore/react-native-hms-location --saveUsing Download Link
- Download the module and copy it into '@hmscore' folder in 'node_modules' folder. The folder structure can be seen below;
project-name
|_ node_modules
|_ ...
|_ @hmscore
|_ ...
|_ react-native-hms-location
|_ ...
|_ ...- Add following lines into 'android/settings.gradle' file
include ':react-native-hms-location'
project(':react-native-hms-location').projectDir = new File(rootProject.projectDir, '../node_modules/@hmscore/react-native-hms-location/android')- Add 'react-native-hms-location' dependency into 'android/app/build.gradle' file.
implementation project(":react-native-hms-location")- Add 'RNHMSLocationPackage' to your application.
import com.huawei.hms.rn.location.RNHMSLocationPackage;
...
...
@Override
protected List<ReactPackage> getPackages() {
@SuppressWarnings("UnnecessaryLocalVariable")
List<ReactPackage> packages = new PackageList(this).getPackages();
packages.add(new RNHMSLocationPackage());
return packages;
}- Initialize Location Kit in your React-Native project in order to make event mechanisms work properly.
import HMSLocation from '@hmscore/react-native-hms-location';
// Initialize Location Kit
useEffect(() => {
HMSLocation.LocationKit.Native.init()
.then(_ => console.log("Done loading"))
.catch(ex => console.log("Error while initializing." + ex));}, []);API Definition
Modules Overview
| Module | Description |
|---|---|
| LocationKit | A module for initializing the package and enabling/disabling logger. |
| FusedLocation | With this module you can check the device location settings, get the last known location information once or continuously, set mock location and others |
| ActivityIdentification | If your app needs to obtain the activity status of the user's device (for example, walking, running, or bicycling) or your app needs to detect activity status change of a user, you can use this module. |
| Geofence | If you are interested in a place, you can create a geofence based on the place. When the device enters the geofence or stays for a duration of time, a notification can be sent to your app. |
LocationKit Module
Method Summary:
| Return Type | Function | Description |
|---|---|---|
Promise<boolean> |
init() | Initialize plugin. |
Promise<boolean> |
enableLogger() | This method enables HMSLogger capability which is used for sending usage analytics of Location SDK's methods to improve the service quality. |
Promise<boolean> |
disableLogger() | This method disables HMSLogger capability which is used for sending usage analytics of Location SDK's methods to improve the service quality. |
init()
Initialize plugin.
Return Type
| Type | Description |
|---|---|
Promise<boolean> |
Promise that resolves true if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
HMSLocation.LocationKit.Native.init()
.then(_ => console.log("Done loading"))
.catch(ex => console.log("Error while initializing." + ex));enableLogger()
This method enables HMSLogger capability which is used for sending usage analytics of Location SDK's methods to improve the service quality
Return Type
| Type | Description |
|---|---|
Promise<boolean> |
Promise that resolves true if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
HMSLocation.LocationKit.Native.enableLogger()
.then(_ => console.log("HMS Logger enabled"));disableLogger()
This method disables HMSLogger capability which is used for sending usage analytics of Location SDK's methods to improve the service quality
Return Type
| Type | Description |
|---|---|
Promise<boolean> |
Promise that resolves true if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
HMSLocation.LocationKit.Native.disableLogger()
.then(_ => console.log("HMS Logger disabled"));FusedLocation Module
Method Summary:
| Return Type | Function | Description |
|---|---|---|
Promise<booelan> |
flushLocations() | This API is used to update locations being processed. |
Promise<LocationSettingsStates> |
checkLocationSettings() | This API is used to check whether related location settings are available. |
Promise<Location> |
getLastLocation() | This API is used to obtain the latest available location. |
Promise<NavigationResult> |
getNavigationContextState() | This API is used for obtaining navigation status and checking whether the user device supports high-precision location. |
Promise<LocationData> |
getLastLocationWithAddress() | This API is used to obtain the available location of the last request, including the detailed address information. |
Promise<LocationAvailability> |
getLocationAvailability() | This API is used to check whether the location data is available. |
Promise<boolean> |
setMockMode() | This API is used to specify whether the location provider uses the location mock mode. If yes, the GPS or network location is not used and the location set through setMockLocation() is directly returned. |
Promise<boolean> |
setMockLocation() | This API is used to update locations being processed if mock location is being used. |
Promise<RequestCodeLocation> |
requestLocationUpdatesWithCallback() | This API is used to request location updates. |
Promise<RequestCodeLocation> |
requestLocationUpdatesWithCallbackEx() | This is an extended location service API that supports high-precision location and is compatible with common location APIs. |
| void | addFusedLocationEventListener() | This API is used to set a callback function that is continuously called with location data. |
| void | removeFusedLocationEventListener() | This API is used to remove the event listener that is added by addFusedLocationEventListener() |
Promise<boolean> |
removeLocationUpdates() | This API is used to remove location updates of the specified callback information. |
Promise<boolean> |
requestPermission() | This API is used to request permission to use location services. |
Promise<HasPermissionResult> |
hasPermission() | This API is used to check if the permission to use location services has been granted. |
flushLocations()
This API is used to update locations being processed.
Return Type
| Type | Description |
|---|---|
Promise<boolean> |
Promise that resolves true if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
HMSLocation.LocationKit.Native.flushLocations()
.then(_ => console.log("HMS Logger disabled"));checkLocationSettings()
This API is used to check whether related location settings are available.
Parameters
| Name | Type | Description |
|---|---|---|
| request | LocationRequest | Request object for checking location settings. |
Return Type
| Type | Description |
|---|---|
Promise<LocationSettingsStates> |
Promise that resolves LocationSettingsStates object if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
const locationRequest = {
id: "locationRequest" + Math.random() * 10000,
priority: HMSLocation.FusedLocation.PriorityConstants.PRIORITY_HIGH_ACCURACY,
interval: 5000,
numUpdates: 20,
fastestInterval: 6000,
expirationTime: 100000,
expirationTimeDuration: 100000,
smallestDisplacement: 0,
maxWaitTime: 1000.0,
needAddress: false,
language: "en",
countryCode: "en",
};
const locationSettingsRequest = {
locationRequests: [locationRequest],
alwaysShow: false,
needBle: false,
};
HMSLocation.FusedLocation.Native.checkLocationSettings(locationSettingsRequest)
.then(res => setLocationSettings(res))
.catch(ex => console.log("Error while getting location settings. " + ex))getNavigationContextState()
This API is used for obtaining navigation status and checking whether the user device supports high-precision location.
Parameters
| Name | Type | Description |
|---|---|---|
| request | NavigationRequestConstants | Navigation request constant |
Return Type
| Type | Description |
|---|---|
Promise<NavigationResult> |
Promise that resolves NavigationResult object if the operation is successful |
Call Example:
HMSLocation.FusedLocation.Native.getNavigationContextState(
HMSLocation.FusedLocation.NavigationRequestConstants.IS_SUPPORT_EX)
.then(res => setNavigationState(res))
.catch(ex => console.log("Error while getting navigation state. " + ex))getLastLocation()
This API is used to obtain the latest available location.
Return Type
| Type | Description |
|---|---|
Promise<Location> |
Promise that resolves Location object if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
HMSLocation.FusedLocation.Native.getLastLocation()
.then(pos => setPosition(pos))
.catch(err => console.log('Failed to get last location', err));getLastLocationWithAddress()
This API is used to obtain the available location of the last request, including the detailed address information.
Parameters
| Name | Type | Description |
|---|---|---|
| request | LocationRequest | Location request object |
Return Type
| Type | Description |
|---|---|
Promise<HWLocation> |
Promise that resolves HWLocation object if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
const locationRequest = {
id: 'e0048e' + Math.random() * 10000,
priority: HMSLocation.FusedLocation.PriorityConstants.PRIORITY_HIGH_ACCURACY,
interval: 3,
numUpdates: 10,
fastestInterval: 1000.0,
expirationTime: 200000.0,
expirationTimeDuration: 200000.0,
smallestDisplacement: 0.0,
maxWaitTime: 2000000.0,
needAddress: true,
language: 'en',
countryCode: 'en',
};
HMSLocation.FusedLocation.Native.getLastLocationWithAddress(locationRequest)
.then(res => { console.log('Address: ', res) });getLocationAvailability()
This API is used to check whether the location data is available.
Return Type
| Type | Description |
|---|---|
Promise<LocationAvailability> |
Promise that resolves LocationAvailability object if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
HMSLocation.FusedLocation.Native.getLocationAvailability()
.then(red => setLocationAvailable(res))
.catch(err => console.log('Failed to get location availability', err));removeLocationUpdates()
This API is used to remove location updates of the specified callback information.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String |
A string that contains the request ID obtained from the response of requestLocationUpdatesWithCallback or requestLocationUpdatesWithCallbackEx functions |
Return Type
| Type | Description |
|---|---|
Promise<boolean> |
Promise that resolves true if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
const locactionUpdateId = "locationRequest" + Math.random() * 10000,
HMSLocation.LocationKit.Native.removeLocationUpdates(locactionUpdateId)
.then(_ => console.log("Remove location update successful"));requestLocationUpdatesWithCallback()
This API is used to request location updates.
Parameters
| Name | Type | Description |
|---|---|---|
| request | LocationRequest | Location request object |
Return Type
| Type | Description |
|---|---|
Promise<RequestCodeLocation> |
Promise that resolves RequestCodeLocation object if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
const locationRequest = {
id: 'e0048e' + Math.random() * 10000,
priority: HMSLocation.FusedLocation.PriorityConstants.PRIORITY_HIGH_ACCURACY,
interval: 3,
numUpdates: 10,
fastestInterval: 1000.0,
expirationTime: 200000.0,
expirationTimeDuration: 200000.0,
smallestDisplacement: 0.0,
maxWaitTime: 2000000.0,
needAddress: true,
language: 'en',
countryCode: 'en',
};
HMSLocation.FusedLocation.Native.requestLocationUpdatesWithCallback(locationRequest)
.then(({ requestCode }) => setLocationUpdateId(requestCode))
.catch(ex => console.log("Exception while requestLocationUpdatesWithCallback " + ex))
requestLocationUpdatesWithCallbackEx()
This API is also used to request location updates. But this is an extended location service API that supports high-precision location and is compatible with common location APIs.
Parameters
| Name | Type | Description |
|---|---|---|
| request | LocationRequest | Location Request object |
Return Type
| Type | Description |
|---|---|
Promise<LocationRequest> |
Promise that resolves LocationRequest object if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
const locationRequest = {
id: 'e0048e' + Math.random() * 10000,
priority: HMSLocation.FusedLocation.PriorityConstants.PRIORITY_HIGH_ACCURACY,
interval: 3,
numUpdates: 10,
fastestInterval: 1000.0,
expirationTime: 200000.0,
expirationTimeDuration: 200000.0,
smallestDisplacement: 0.0,
maxWaitTime: 2000000.0,
needAddress: true,
language: 'en',
countryCode: 'en',
};
HMSLocation.FusedLocation.Native.requestLocationUpdatesWithCallbackEx(locationRequest)
.then(({ requestCode }) => setLocationUpdateId(requestCode))
.catch(ex => console.log("Exception while requestLocationUpdatesWithCallbackEx " + ex))
setMockMode()
This API is used to specify whether the location provider uses the location mock mode. If yes, the GPS or network location is not used and the location set through setMockLocation (Location) is directly returned.
Parameters
| Name | Type | Description |
|---|---|---|
| shouldMock | boolean |
Should mock location |
Return Type
| Type | Description |
|---|---|
Promise<boolean> |
Promise that resolves true if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
HMSLocation.FusedLocation.Native.setMockMode(true)
.then(res => console.log('Mock mode ', res))
.catch(err => console.log(err));setMockLocation()
This API is used to update locations being processed if mock location is being used.
Parameters
| Name | Type | Description |
|---|---|---|
| location | LatLng | Mock location |
Return Type
| Type | Description |
|---|---|
Promise<boolean> |
Promise that resolves true if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
// Location object
const latLng = { latitude: 41.2, longitude: 29.1 };
HMSLocation.FusedLocation.Native.setMockLocation(latLng)
.then(res => console.log('Mock set ', res))
.catch(err => console.log(err));requestPermission()
This API is used to request permission to use location services.
Return Type
| Type | Description |
|---|---|
Promise<LocationPermissionResult> |
Promise that resolves LocationPermissionResult object if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
HMSLocation.FusedLocation.Native.requestPermission()
.then(res=> console.log("Location Request Permission res: ", res));hasPermission()
This API is used to check if the permission to use location services has been granted.
Return Type
| Type | Description |
|---|---|
Promise<HasPermissionResult> |
Promise that resolves HasPermissionResult object if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
HMSLocation.FusedLocation.Native.hasPermission()
.then(result => setHasLocationPermission(result))
.catch(ex => console.log("Error while getting location permission info: " + ex));addFusedLocationEventListener()
This function takes a callback function that is continuously called with location data. You need to register for updates first by using the requestLocationUpdatesWithCallback() or requestLocationUpdatesWithCallbackwx() functions.
Parameters
| Name | Type | Description |
|---|---|---|
| fn | (res:Location) => void |
Callback function that takes Location object as argument |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
const handleLocationUpdate = location => {
console.log(location);
setPosition(location);
};
HMSLocation.FusedLocation.Events.addFusedLocationEventListener(
handleLocationUpdate,
);removeFusedLocationEventListener()
This API is used to remove the event listener that is added by addFusedLocationEventListener()
Parameters
| Name | Type | Description |
|---|---|---|
| id | String |
A string that contains the request ID. |
| fn | (res:Location) => void |
Callback function that takes Location object as argument |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
const handleLocationUpdate = location => {
console.log(location);
setPosition(location);
};
HMSLocation.FusedLocation.Events.removeFusedLocationEventListener(
locationUpdateId,
handleLocationUpdate,
);ActivityIdentification Module
Method Summary:
| Return Type | Function | Description |
|---|---|---|
Promise<RequestCode> |
createActivityConversionUpdates() | This API is used to activity conversions (entering and exit), for example, detecting user status change from walking to bicycling. |
| void | addActivityConversionEventListener() | This API is used to take set a callback function that is continuously called with activity conversion data. You need to register for updates first by using the createActivityConversionUpdates() function. |
| void | removeActivityConversionEventListener() | This API is used to remove the event listener that is added by addActivityConversionEventListener(). |
Promise<boolean> |
deleteActivityConversionUpdates() | This API is used to remove activity conversion updates by their request code. |
Promise<RequestCode> |
createActivityIdentificationUpdates() | This API is used to register for activity identification updates. After this, you can subscribe to updates using addActivityIdentificationEventListener() function. |
| void | addActivityIdentificationEventListener() | This API is used to take set a callback function that is continuously called with activity identification data. You need to register for updates first by using the createActivityIdentificationUpdates() function. |
| void | removeActivityIdentificationEventListener() | This API is used to remove the event listener that is added by addActivityIdentificationEventListener() |
Promise<boolean> |
deleteActivityIdentificationUpdates() | This API is used to remove activity identification updates by their request code. |
Promise<boolean> |
requestPermission() | This API is used to request permission to use activity identification services. |
Promise<HasPermissionResult> |
hasPermission() | This API is used to check if the permission to use activity identfication services has been granted. |
createActivityConversionUpdates()
This API is used to detect activity conversions (entering and exit), for example, detecting user status change from walking to bicycling. After this, you can subscribe to updates using addActivityConversionEventListener() function.
Parameters
| Name | Type | Description |
|---|---|---|
| request | ActivityConversionRequest[] | Request object array for activity conversion update. |
Return Type
| Type | Description |
|---|---|
Promise<RequestCode> |
Promise that resolves RequestCode` object if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
const activityConversionRequestArray = [
// STILL
{
conversionType: HMSLocation.ActivityIdentification.ActivityConversions.ENTER_ACTIVITY_CONVERSION,
activityType: HMSLocation.ActivityIdentification.Activities.STILL
},
{
conversionType: HMSLocation.ActivityIdentification.ActivityConversions.EXIT_ACTIVITY_CONVERSION,
activityType: HMSLocation.ActivityIdentification.Activities.STILL
},
// ON FOOT
{
conversionType: HMSLocation.ActivityIdentification.ActivityConversions.ENTER_ACTIVITY_CONVERSION,
activityType: HMSLocation.ActivityIdentification.Activities.FOOT
},
{
conversionType: HMSLocation.ActivityIdentification.ActivityConversions.EXIT_ACTIVITY_CONVERSION,
activityType: HMSLocation.ActivityIdentification.Activities.FOOT
},
// RUNNING
{
conversionType: HMSLocation.ActivityIdentification.ActivityConversions.ENTER_ACTIVITY_CONVERSION,
activityType: HMSLocation.ActivityIdentification.Activities.RUNNING
},
{
conversionType: HMSLocation.ActivityIdentification.ActivityConversions.EXIT_ACTIVITY_CONVERSION,
activityType: HMSLocation.ActivityIdentification.Activities.RUNNING
}
];
HMSLocation.ActivityIdentification.Native.createActivityConversionUpdates(activityConversionRequestArray)
.then(res => {
console.log(res);
setConvReqCode(res.requestCode);
})
.catch(err => console.log('ERROR: Activity Conversion creation failed', err));deleteActivityConversionUpdates()
This API is used to remove activity conversion updates by their request code.
Parameters
| Name | Type | Description |
|---|---|---|
| requestCode | String |
Request code obtained from the response of createActivityConversionUpdates() function. |
Return Type
| Type | Description |
|---|---|
Promise<boolean> |
Promise that resolves true if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
HMSLocation.ActivityIdentification.Native.deleteActivityConversionUpdates(convReqCode)
.then(res => {
console.log(res);
setConvReqCode(null);
})
.catch(err => console.log('ERROR: Activity Conversion deletion failed', err));createActivityIdentificationUpdates()
This API is used to register for activity identification updates. After this, you can subscribe to updates using addActivityIdentificationEventListener() function.
Parameters
| Name | Type | Description |
|---|---|---|
| intervalMillis | number | Interval for activity identification updates, in milliseconds. |
Return Type
| Type | Description |
|---|---|
Promise<RequestCode> |
Promise that resolves RequestCode object if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
HMSLocation.ActivityIdentification.Native.createActivityIdentificationUpdates(2000)
.then(res => {
console.log(res);
setIdReqCode(res.requestCode);
})
.catch(err => console.log('ERROR: Activity identification failed', err));deleteActivityIdentificationUpdates()
This API is used to remove activity identification updates by their request code.
Parameters
| Name | Type | Description |
|---|---|---|
| requestCode | String |
Request code obtained from the response of createActivityIdentificationUpdates() function. |
Return Type
| Type | Description |
|---|---|
Promise<boolean> |
Promise that resolves true if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
HMSLocation.ActivityIdentification.Native.deleteActivityIdentificationUpdates(idReqCode)
.then(res => {
console.log(res);
setIdReqCode(null);
})
.catch(err => console.log('ERROR: Activity identification deletion failed', err));requestPermission()
This API is used to request activity permissions.
Return Type
| Type | Description |
|---|---|
Promise<ActivityPermissionResult> |
Promise that resolves ActivityPermissionResult object if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
HMSLocation.ActivityIdentification.Native.requestPermission()
.then(res=> console.log("Activity Request Permission res: ", res));hasPermission()
This API is used to check if the permission to gather activity information.
Return Type
| Type | Description |
|---|---|
Promise<HasPermissionResult> |
Promise that resolves HasPermissionResult object if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
HMSLocation.ActivityIdentification.Native.hasPermission()
.then(result => setHasActivityIdentificationPermission(result))
.catch(ex => console.log("Error while getting activity identification permission info: " + ex));addActivityConversionEventListener()
This function takes a callback function that is continuously called with activity conversion data. You need to register for updates first by using the createActivityConversionUpdates() function.
Parameters
| Name | Type | Description |
|---|---|---|
| fn | (res:ActivityConversionData) => void |
Callback function that takes ActivityConversionData object as argument |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
const handleActivityConversion = location => {
console.log('CONVERSION : ', conv);
setConversionResponse(conv);
};
HMSLocation.ActivityIdentification.Events.addActivityConversionEventListener(
handleActivityConversion,
);removeActivityConversionEventListener()
This API is used to remove the event listener that is added by addActivityConversionEventListener()
Parameters
| Name | Type | Description |
|---|---|---|
| fn | (res:ActivityConversionData) => void |
Callback function that takes ActivityConversionData object as argument |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
const handleActivityConversion = location => {
console.log('CONVERSION : ', conv);
setConversionResponse(conv);
};
HMSLocation.ActivityIdentification.Events.removeActivityConversionEventListener(
handleActivityConversion,
);addActivityIdentificationEventListener()
This function takes a callback function that is continuously called with activity identification data. You need to register for updates first by using the createActivityIdentificationUpdates() function.
Parameters
| Name | Type | Description |
|---|---|---|
| fn | (res:ActivityIdentificationData) => void |
Callback function that takes ActivityIdentificationData object as argument |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
const handleActivityIdentification = act => {
console.log('ACTIVITY : ', act);
setIdentificationResponse(act);
};
HMSLocation.ActivityIdentification.Events.addActivityIdentificationEventListener(
handleActivityIdentification,
);removeActivityIdentificationEventListener()
This API is used to remove the event listener that is added by addActivityIdentificationEventListener()
Parameters
| Name | Type | Description |
|---|---|---|
| fn | (res:ActivityIdentificationData) => void |
Callback function that takes ActivityIdentificationData object as argument |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
const handleActivityConversion = location => {
console.log('CONVERSION : ', conv);
setConversionResponse(conv);
};
HMSLocation.ActivityIdentification.Events.removeActivityIdentificationEventListener(
handleActivityIdentification,
);Geofence Module
Method Summary:
| Return Type | Function | Description |
|---|---|---|
Promise<GeofenceResponse> |
createGeofenceList() | This API is used to add multiple geofences. When a geofence is triggered, a notification is broadcasted. You can subscribe to the broadcast by using addGeofenceEventListener() function. |
Promise<boolean> |
deleteGeofenceList() | This API is used to remove geofences by their request IDs. An error is reported if the list is empty. |
void |
addGeofenceEventListener() | This API is used to subscribe geofence updates. It takes a callback function that is continuously called with geofence data. You need to register for updates first by using the createGeofenceList() function. |
void |
removeGeofenceEventListener() | This function removes the event listener that is added by addGeofenceEventListener() |
createGeofenceList()
This API is used to add geofences. When a geofence is triggered, a notification is broadcasted. You can subscribe to the broadcast by using addGeofenceEventListener() function.
Parameters
| Name | Type | Description |
|---|---|---|
| geofences | Geofence[] | Array of Geofence objects. |
| initConversion | number | Geofence convert type. Please refer to Init Constants to see options. |
| coordinateType | number | Coordinate type. Please refer to Type Constants to see options |
Return Type
| Type | Description |
|---|---|
Promise<RequestCode> |
Promise that resolves RequestCode object if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
const geofence1 = {
longitude: 42.0,
latitude: 29.0,
radius: 20.0,
uniqueId: 'e00322',
conversions: 1,
validContinueTime: 10000.0,
dwellDelayTime: 10,
notificationInterval: 1,
};
const geofence2 = {
longitude: 41.0,
latitude: 27.0,
radius: 340.0,
uniqueId: 'e00491',
conversions: 2,
validContinueTime: 1000.0,
dwellDelayTime: 10,
notificationInterval: 1,
};
const geofenceRequest = {
geofences: [geofence1, geofence2],
conversions: 1,
coordinate: 1,
};
HMSLocation.Geofence.Native.createGeofenceList(
geofenceRequest.geofences,
geofenceRequest.conversions,
geofenceRequest.coordinate,
)
.then(res => {
console.log(res);
setReqCode(parseInt(res.requestCode));
})
.catch(err => {
console.log(err);
});deleteGeofenceList()
This API is used to remove geofences by their request code.
Parameters
| Name | Type | Description |
|---|---|---|
| requestCode | number |
Request code obtained from the response of createGeofenceList() function. |
Return Type
| Type | Description |
|---|---|
Promise<boolean> |
Promise that resolves true if the operation is successful |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
HMSLocation.Geofence.Native.deleteGeofenceList(reqCode)
.then(res => {
console.log(res);
setReqCode(null);
})
.catch(err => console.log('ERROR: GeofenceList deletion failed', err))addGeofenceEventListener()
This API is used to subscribe geofence updates. It takes a callback function that is continuously called with geofence data. You need to register for updates first by using the createGeofenceList() function.
Parameters
| Name | Type | Description |
|---|---|---|
| fn | (res:GeofenceData) => void |
Callback function that takes GeofenceData object as argument |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
const handleGeofenceEvent = geo => {
console.log('GEOFENCE : ', geo);
setGeofenceResponse(geo);
};
HMSLocation.Geofence.Events.addGeofenceEventListener(
handleGeofenceEvent,
);removeGeofenceEventListener()
This API is used to remove the event listener that is added by addGeofenceEventListener()
Parameters
| Name | Type | Description |
|---|---|---|
| fn | (res:GeofenceData) => void |
Callback function that takes GeofenceData object as argument |
Call Example:
import HMSLocation from '@hmscore/react-native-hms-location';
const handleGeofenceEvent = geo => {
console.log('GEOFENCE : ', geo);
setGeofenceResponse(geo);
};
HMSLocation.Geofence.Events.removeGeofenceEventListener(
handleGeofenceEvent,
)Data Types
RequestCodeLocation
| Field | Type | Description |
|---|---|---|
| requestCode | String | Request code |
LocationAvailability
| Fields | Type | Description |
|---|---|---|
| isLocationAvailable | boolean | Indicates if the location is available or not. |
Location
A simple object that contains data about location.
| Field | Type | |
|---|---|---|
| latitude | number | Latitude of a location. If no latitude is available, 0.0 is returned. |
| longitude | number | Longitude of a location. If no longitude is available, 0.0 is returned. |
| speed | number | Speed of a device at the current location, in meters per second. If no speed is available, 0.0 is returned. |
| bearing | number | Bearing of a device at the current location, in degrees. If no bearing is available, 0.0 is returned. |
| accuracy | number | Horizontal error of a location, in meters. If no horizontal error is available, 0.0 is returned. |
| verticalAccuracyMeters | number | Vertical error of a location, in meters. If no vertical error is available, 0.0 is returned. |
| bearingAccuracyDegrees | number | Bearing error of the current location, in degrees. If no bearing error is available, 0.0 is returned. |
| speedAccuracyMetersPerSecond | number | Speed error of a device at the current location, in meters per second. If no speed error is available, 0.0 is returned. |
| time | number | Current timestamp, in milliseconds. |
| fromMockProvider | boolean | Indicates whether location coming from mock provider. |
HWLocation
A simple object that contains data about location.
| Fields | Type | Description |
|---|---|---|
| latitude | number | Latitude of a location. If no latitude is available, 0.0 is returned. |
| longitude | number | Longitude of a location. If no longitude is available, 0.0 is returned. |
| altitude | number | Altitude of the current location. If no altitude is available, 0.0 will be returned. |
| speed | number | Speed of a device at the current location, in meters per second. If no speed is available, 0.0 is returned. |
| bearing | number | Bearing of a device at the current location, in degrees. If no bearing is available, 0.0 is returned. |
| accuracy | number | Horizontal error of a location, in meters. If no horizontal error is available, 0.0 is returned. |
| provider | string | Location method, such as network location, GNSS, Wi-Fi, and Bluetooth. If no location method is available, null will be returned. |
| time | number | Current timestamp, in milliseconds. |
| elapsedRealtimeNanos | number | Time elapsed since system boot, in nanoseconds. |
| countryName | string | Country name. If no country name is available, null will be returned. |
| state | string | Administrative region. If no administrative region is available, null will be returned. |
| city | string | City. If no city is available, null will be returned. |
| county | string | District/county. If no district/county is available, null will be returned. |
| street | string | Street. If no street is available, null will be returned. |
| featureName | string | Feature building of the current location. If no feature building is available, null will be returned. |
| postalCode | string | Postal code of the current location. If no postal code is available, null will be returned. |
| phone | string | Phone number of the feature building (such as a store or company) of the current location. If no phone number is available, null will be returned. |
| url | string | Website of the feature building (such as a store or company) of the current location. If no website is available, null will be returned. |
| extraInfo | string | Additional information, which is a key-value pair. If no additional information is available, null will be returned. |
| verticalAccuracyMeters | number | Vertical error of a location, in meters. If no vertical error is available, 0.0 is returned. |
| bearingAccuracyDegrees | number | Bearing error of the current location, in degrees. If no bearing error is available, 0.0 is returned. |
LocationRequest
A simple object that contains required information for location request.
| Field | Type | Description |
|---|---|---|
| priority | number | Request priority. The default value is 100. |
| interval | number | Request interval, in milliseconds. The default value is 3600000. |
| numUpdates | number | Number of requested location updates. |
| fastestInterval | number | Shortest request interval, in milliseconds. The default value is 600000. If another app initiates a location request, the location is also reported to the app at the interval specified in fastestInterval. |
| expirationTime | number | Request expiration time, in milliseconds. |
| expirationTimeDuration | number | Request expiration duration, in milliseconds. |
| smallestDisplacement | number | Minimum displacement between location updates, in meters. |
| maxWaitTime | number | Maximum waiting timeIndicates whether to return the address information. |
| needAddress | boolean | Indicates whether to return the address information. The default value is false. |
| language | String | Language. The value consists of two letters and complies with the ISO 639-1 international standard. By default, the value is empty. |
| countryCode | String | Country code. The value consists of two letters and complies with the ISO 3166-1 international standard. By default, the value is empty. |
LocationSettingsRequest
A simple object that contains required information for location settings request.
| Fields | Type | Description |
|---|---|---|
| locationRequests | LocationRequest[] | Collection of LocationRequest object. |
| needBle | boolean | Indicates whether BLE scanning needs to be enabled. The options are true (yes) and false (no). |
| alwaysShow | boolean | Indicates whether a location is required for the app to continue. The options are true (yes) and false (no). |
LocationSettingsStates
A simple object that contains location settings states.
| Fields | Type | Description |
|---|---|---|
| isBlePresent | boolean | Ble is present or not |
| isBleUsable | boolean | Ble is usable or not |
| isGpsPresent | boolean | Gps is present or not |
| isGpsUsaGps | boolean | Ble is usable or not |
| isLocationPresent | boolean | Location is present or not |
| isLocationUsable | boolean | Location is usable or not |
| isNetworkLocationPresent | boolean | Network location is present or not |
| isNetworkLocationUsable | boolean | Network location is usable or not |
LocationPermissionResult
A simple object that contains location permission information.
| Fields | Type | Description |
|---|---|---|
| granted | boolean | Permission is granted or not. |
| fineLocation | boolean | Fine location permission is granted or not. |
| coarseLocation | boolean | Coarse location permission is granted or not. |
| backgroundLocation | boolean | ackground location permission is granted or not. |
LatLng
A simple object that contains required information about latitude and longitude.
| Fields | Type | Description |
|---|---|---|
| longitude | float | Longitude of a location. |
| latitude | float | Latitude of a location. |
NavigationResult
A simple object that contains required information about navigation type.
| Fields | Type | |
|---|---|---|
| state | String | Status information. |
| possibility | String | Confidence of the status information. |
HasPermissionResult
| Fields | Type | Description |
|---|---|---|
| hasPermission | boolean | Indicates if the permission is available or not. |
RequestCode
| Field | Type | Description |
|---|---|---|
| requestCode | number | Request code |
ActivityConversionInfo
A simple object that contains information about activity conversions.
| Fields | Type | Description |
|---|---|---|
| conversionType | number | Activity conversion information. The options are Activities.ENTER_ACTIVITY_CONVERSION and Activities.EXIT_ACTIVITY_CONVERSION. |
| activityType | number | Activity type. Please refer to Constants to see options. |
ActivityConversionData
A simple object that contains information about activity conversions.
| Fields | Type | Description |
|---|---|---|
| activityType | number | Activity type. Please refer to Constants to see options. |
| elapsedTimeFromReboot | number | The elapsed real time (in milliseconds) of this conversion since boot, including sleeping time obtained by SystemClock.elapsedRealtime(). |
| conversionType | number | Activity conversion information. The options are Activities.ENTER_ACTIVITY_CONVERSION and Activities.EXIT_ACTIVITY_CONVERSION. |
ActivityConversionRequest
| Fields | Type | Description |
|---|---|---|
| conversionType | number | Conversion type. |
| activityType | number | Activity type. |
ActivityConversionResponse
A simple object that contains activity conversion response.
| Fields | Type | Description |
|---|---|---|
| activityConversionDatas | ActivityConversionData[] | All activity conversion events in the result. The obtained activity events are sorted by time in ascending order. |
ActivityIdentificationData
A simple object that contains activity conversion data.
| Fields | Type | Description |
|---|---|---|
| possibility | number | Confidence information. |
| identificationActivity | number | Detected activity type. |
ActivityIdentificationResponse
A simple object that contains activity identification response.
| Fields | Type | Description |
|---|---|---|
| elapsedTimeFromReboot | number | The elapsed real time (in milliseconds) of this detection since boot, including sleeping time obtained by SystemClock.elapsedRealtime(). |
| mostActivityIdentification | number | The most probable activity identification of the user. |
| activityIdentificationDatas | ActivityIdentificationData[] | The list of activitiy identification list. The activity identifications are sorted by most probable activity first. |
| time | number | The time of this identification, which is in milliseconds since January 1, 1970,obtained by System.currentTimeMillis(). |
ActivityPermissionResult
A simple object that contains location permission information.
| Fields | Type | Description |
|---|---|---|
| granted | boolean | Permission is granted or not. |
| activityRecognition | boolean | Activitiy recognation permission. |
Geofence
A simple object that contains information about geofence.
| Fields | Type | Description |
|---|---|---|
| longitude | number | Longitude. The value range is [-180,180]. |
| latitude | number | Latitude. The value range is [-90,90]. |
| radius | number | Radius, in meters. |
| uniqueId | String | Unique ID. If the unique ID already exists, the new geofence will overwrite the old one. |
| conversions | number | Geofence conversions. The bitwise-OR operation is supported. |
| validContinueTime | number | Geofence timeout interval, in milliseconds. The geofence will be automatically deleted after this amount of time. |
| dwellDelayTime | number | Geofence timeout interval, in milliseconds. The geofence will be automatically deleted after this amount of time. |
| notificationInterval | number | Notification response capability. The default value is 0. Setting it to a larger value can reduce power consumption accordingly. However, reporting of geofence events may be delayed. |
GeofenceResponse
A geofence response object.
| Fields | Type | Description |
|---|---|---|
| uniqueId | String | Unique id |
GeofenceData
A geofence data object.
| Fields | Type | |
|---|---|---|
| convertingGeofenceList | GeofenceResponse[] | Information about converted geofences. |
| conversion | number | Geofence convert type. |
| convertingLocation | Location | The location when a geofence is converted. |
| errorCode | number | Error code. For details, please refer to Error Codes. |
| errorMessage | String | Detailed error message. |
Constants
FusedLocation Constants
PriorityConstants
| Name | Type | Value | Description |
|---|---|---|---|
| PRIORITY_BALANCED_POWER_ACCURACY | number | 102 |
Used to request the block-level location. |
| PRIORITY_HIGH_ACCURACY | number | 100 |
Used to request the most accurate location. |
| PRIORITY_LOW_POWER | number | 104 |
Used to request the city-level location. |
| PRIORITY_NO_POWER | number | 105 |
Used to request the location with the optimal accuracy without additional power consumption. |
NavigationRequestConstants
| Name | Type | Value | Description |
|---|---|---|---|
| IS_SUPPORT_EX | number | 2 |
Used to check whether the device supports high-precision location. |
ActivityIdentification Constants
Activities
| Name | Type | Value | Description |
|---|---|---|---|
| VEHICLE | number | 100 |
The device user is in a vehicle, such as car. |
| BIKE | number | 101 |
The device user is on a bicycle. |
| FOOT | number | 102 |
The device user is walking or running. |
| RUNNING | number | 108 |
The device user is running, which is a sub-activity of FOOT. |
| STILL | number | 103 |
The device user is still. |
| TILTING | number | 105 |
The device is in an obvious tilt status |
| OTHERS | number | 104 |
The device is in other status |
| WALKING | number | 107 |
The device user is walking. It is a sub-activity of FOOT |
ActivitiyConversions
| Name | Type | Value | Description |
|---|---|---|---|
| ENTER_ACTIVITY_CONVERSION | number | 0 |
A user enters the given activity |
| EXIT_ACTIVITY_CONVERSION | number | 1 |
A user exits the given activity. |
Geofence Constants
GeofenceConstants
| Name | Type | Value | Description |
|---|---|---|---|
| ENTER_GEOFENCE_CONVERSION | number | 1 |
A user enters the geofence. |
| EXIT_GEOFENCE_CONVERSION | number | 2 |
A user exits the geofence. |
| DWELL_GEOFENCE_CONVERSION | number | 4 |
A user lingers in the geofence. |
| GEOFENCE_NEVER_EXPIRE | number | -1 |
No timeout interval is configured for the geofence. |
GeofenceRequestConstants
| Name | Type | Value | Description |
|---|---|---|---|
| ENTER_INIT_CONVERSION | number | 1 |
ENTER_GEOFENCE_CONVERSION is triggered immediately when a request is initiated to add the geofence where a user device has already entered. |
| EXIT_INIT_CONVERSION | number | 2 |
EXIT_GEOFENCE_CONVERSION is triggered immediately when a request is initiated to add the geofence where a user device has already exited. |
| DWELL_INIT_CONVERSION | number | 4 |
DWELL_GEOFENCE_CONVERSION is triggered immediately when a request is initiated to add the geofence where a user device has already entered and stayed for the specified duration. |
| COORDINATE_TYPE_WGS_84 | number | 1 |
Use the coordinate type WGS_84 |
| COORDINATE_TYPE_GCJ_02 | number | 0 |
Use the coordinate type GCJ_02. |
ErrorCodes
| Name | Type | Value | Description |
|---|---|---|---|
| GEOFENCE_NUMBER_OVER_LIMIT | number | 10201 |
The used geofences amount has reached the maximum limitation. |
| GEOFENCE_NUMBER_OVER_LIMIT | number | 10202 |
The used pendingIntent amount (5 pendingIntents) in the geofences reached the maximum limitation. |
| GEOFENCE_NUMBER_OVER_LIMIT | number | 10204 |
Insufficient permission to perform geofence-related operations. |
| GEOFENCE_NUMBER_OVER_LIMIT | number | 10205 |
Geofences are added too frequently. |
| GEOFENCE_NUMBER_OVER_LIMIT | number | 10200 |
The geofence service is unavailable. |
Sample Project
Demo project in example folder, you can find more usage examples in there.
Question or Issues
If you have questions about how to use HMS samples, try the following options:
- Stack Overflowis the best place for any programming questions. Be sure to tag your question with huawei-mobile-services.
- Github is the official repository for these plugins, You can open an issue or submit your ideas.
- Huawei Developer Forum HMS Core Module is great for general questions, or seeking recommendations and opinions.
- Huawei Developer Docs is place to official documentation for all HMS Core Kits, you can find detailed documentations in there.
If you run into a bug in our samples, please submit an issue to the Repository.
License and Terms
Huawei React-Native SDK is licensed under Apache 2.0 license