README

React Native AEP Places Extension

@adobe/react-native-acpplaces is a wrapper around the iOS and Android AEP Places SDK to allow for integration with React Native applications. Functionality to enable Adobe Places is provided entirely through JavaScript documented below.

Installation

You need to install the SDK with npm and configure the native Android/iOS project in your react native project. Before installing the Places extension it is recommended to begin by installing the Core extension.

Note: If you are new to React Native we suggest you follow the React Native Getting Started page before continuing.

1. Create React Native project

First create a React Native project:

react-native init MyReactApp

2. Install JavaScript packages

Install and link the @adobe/react-native-acpplaces package:

cd MyReactApp
npm install @adobe/react-native-acpplaces

2.1 Link

This package requires React Native 0.60+ to build which supports CLI autolink feature to link the modules while building the app.

Note For iOS using cocoapods, run:

cd ios/ && pod install

Tests

This project contains jest unit tests which are contained in the __tests__ directory, to run the tests locally:

make run-tests-locally

Usage

Places

Importing the extension:

import {ACPPlaces} from '@adobe/react-native-acpplaces';

Getting the extension version:

ACPPlaces.extensionVersion().then(version => console.log("AdobeExperienceSDK: ACPPlaces version: " + version));

Registering the extension with ACPCore:

Note: It is recommended to initialize the SDK via native code inside your AppDelegate and MainApplication in iOS and Android respectively.

iOS

#import <RCTACPPlaces/ACPPlaces.h>

[ACPPlaces registerExtension];

Android:

import com.adobe.marketing.mobile.Places;

Places.registerExtension();

Get the nearby points of interest:

let location = new ACPPlacesLocation(<latitude>, <longitude>, <optional altitude>, <optional speed>, <optional accuracy>);
ACPPlaces.getNearbyPointsOfInterest(location, <limit>).then(pois => console.log("AdobeExperienceSDK: ACPPlaces pois: " + pois)).catch(error => console.log("AdobeExperienceSDK: ACPPlaces error: " + error));

Process geofence:

// create a geofence
let geofence = new ACPPlacesGeofence("geofence Identifier", <latitude>, <longitude>, <radius>, <optional expiration-duration>);
ACPPlaces.processGeofence(geofence, ACPPlacesGeofenceTransitionType.ENTER);
ACPPlaces.processGeofence(geofence, ACPPlacesGeofenceTransitionType.EXIT);

Get the current point of interests:

ACPPlaces.getCurrentPointsOfInterest().then(pois => console.log("AdobeExperienceSDK: ACPPlaces pois: " + pois));

Get the last known location

ACPPlaces.getLastKnownLocation().then(location => console.log("AdobeExperienceSDK: ACPPlaces location: " + location));

Clear

ACPPlaces.clear();

Set Authorization status:

ACPPlaces.setAuthorizationStatus(ACPPlacesAuthStatus.ALWAYS);
ACPPlaces.setAuthorizationStatus(ACPPlacesAuthStatus.DENIED);
ACPPlaces.setAuthorizationStatus(ACPPlacesAuthStatus.RESTRICTED);
ACPPlaces.setAuthorizationStatus(ACPPlacesAuthStatus.WHEN_IN_USE);
ACPPlaces.setAuthorizationStatus(ACPPlacesAuthStatus.UNKNOWN);

Additional React Native Plugins

Below is a list of additional React Native plugins from the AEP SDK suite: | Extension | npm package | | ------------ | ------------------------------------------------------------ | | Core | | | Analytics | | | Audience | | | Campaign | | | Media | | | Target | | | User Profile | |