Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including @adobe/react-native-acpplaces-monitor with all npm packages installed. Try it out:

require("react-native/package.json"); // react-native is a peer dependency. require("@adobe/react-native-acpcore/package.json"); // @adobe/react-native-acpcore is a peer dependency. require("@adobe/react-native-acpplaces/package.json"); // @adobe/react-native-acpplaces is a peer dependency. var reactNativeAcpplacesMonitor = require("@adobe/react-native-acpplaces-monitor")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

@adobe/react-native-acpplaces-monitor v0.0.2

Adobe Experience Platform support for React Native apps.

React Native AEP Places Monitor Extension

npm version npm CircleCI NPM

@adobe/react-native-acpplaces-monitor 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-monitor package:

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

2.1 Link

  • React Native 0.60+

CLI autolink feature links the module while building the app.

  • React Native <= 0.59
react-native link @adobe/react-native-acpplaces-monitor

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

PlacesMonitor

Importing the extension:
import {ACPPlacesMonitor} from '@adobe/react-native-acpplaces-monitor';
Getting the extension version:
ACPPlacesMonitor.extensionVersion().then(version => console.log("AdobeExperienceSDK: ACPPlacesMonitor version: " + version));
Registering the extension with ACPCore:
iOS

Within the App's application:didFinishLaunchingWithOptions, register the SDK extensions:

#import "ACPCore.h"
#import "ACPPlaces.h"
#import "ACPPlacesMonitor.h"

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions {
    [ACPCore configureWithAppId:@"yourAppId"];
    [ACPPlaces registerExtension]; //Register Places with Core
    [ACPPlacesMonitor registerExtension]; //Register PlacesMonitor with Core
    [ACPCore start: nil];

    return YES;
}

The following updates are also neccessary for Places Monitor on iOS:

Android

Within the App's OnCreate method, register the SDK extensions and start the Places Monitor:

import com.adobe.marketing.mobile.MobileCore;
import com.adobe.marketing.mobile.Places;
import com.adobe.marketing.mobile.PlacesMonitor;

public class MobileApp extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        MobileCore.setApplication(this);
        MobileCore.ConfigureWithAppId("yourAppId");
        try {
            Places.registerExtension(); //Register Places with Core
            PlacesMonitor.registerExtension(); //Register PlacesMonitor with Core
            MobileCore.start(null);
        } catch (Exception e) {
            //Log the exception
        }
    }
}

The following update is also necessary for Places Monitor on Android:

Start the Places Monitor:
ACPPlacesMonitor.start();
Stop the Places Monitor:
ACPPlacesMonitor.stop(true);
Update the device's location:
ACPPlacesMonitor.updateLocation();
Set or upgrade the location permission request (Android) / request authorization level (iOS):
ACPPlacesMonitor.setRequestLocationPermission(ACPPlacesMonitorLocationPermission.ALWAYS_ALLOW);
ACPPlacesMonitor.setRequestLocationPermission(ACPPlacesMonitorLocationPermission.WHILE_USING_APP);
ACPPlacesMonitor.setRequestLocationPermission(ACPPlacesMonitorLocationPermission.NONE);
Set the monitoring mode (iOS only):
ACPPlacesMonitor.setPlacesMonitorMode(ACPPlacesMonitorModes.CONTINUOUS);
ACPPlacesMonitor.setPlacesMonitorMode(ACPPlacesMonitorModes.SIGNIFICANT_CHANGES);

Additional React Native Plugins

Below is a list of additional React Native plugins from the AEP SDK suite:

Extensionnpm package
Corenpm version
Analyticsnpm version
Audiencenpm version
Campaignnpm version
Medianpm version
Targetnpm version
User Profilenpm version
Placesnpm version

Contributing

See CONTRIBUTING

License

See LICENSE

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free