Adobe Experience Platform - Places plugin for Cordova apps

Notice of deprecation

Since April 25, 2023, Apple has required apps submitted to the App Store to be built with Xcode 14.1 or later. The Experience Platform Mobile SDKs and extensions outlined below were built with prior versions of Xcode and are no longer compatible with iOS and iPadOS given Apple’s current App Store requirements. Consequently, on August 31, 2023, Adobe will be deprecating support for the following Experience Platform Mobile SDKs and wrapper extensions:

• ACP iOS SDK
• Cordova
• Flutter for ACP
• React Native for ACP
• Xamarin

After August 31, 2023, applications already submitted to the App Store that contain these SDKs and wrapper extensions will continue to operate, however, Adobe will not be providing security updates or bug fixes, and these SDKs and wrapper extensions will be provided as-is exclusive of any warranty, due to the App Store policy outlined above.

We encourage all customers to migrate to the latest Adobe Experience Platform versions of the Mobile SDK to ensure continued compatibility and support. Documentation for the latest versions of the Adobe Experience Platform Mobile SDKs can be found here. The iOS migration guide can be found here.

---

• Prerequisites
• Installation
• Usage
• Running Tests
• Sample App
• Additional Cordova Plugins
• Contributing
• Licensing

Prerequisites

Cordova is distributed via Node Package Management (aka - npm).

In order to install and build Cordova applications you will need to have Node.js installed. Install Node.js.

Once Node.js is installed, you can install the Cordova framework from terminal:

sudo npm install -g cordova  

Installation

To start using the Places plugin for Cordova, navigate to the directory of your Cordova app and install the plugin:

cordova plugin add https://github.com/adobe/cordova-acpplaces.git

Check out the documentation for help with APIs

Usage

Getting the SDK version:

ACPPlaces.extensionVersion(function(version){  
    console.log(version);
}, function(error){  
    console.log(error);  
});

Registering the extension with ACPCore:

Note: It is required to initialize the SDK via native code inside your AppDelegate and MainApplication for iOS and Android respectively. For more information see how to initialize Core.

iOS

#import "ACPPlaces.h"  
[ACPPlaces registerExtension];  

Android:

import com.adobe.marketing.mobile.Places;  
Places.registerExtension();

Clear client side Places plugin data:

ACPPlaces.clear(function(response) {  
    console.log("Successfully cleared Places data.");
}, function(error){  
    console.log(error);  
});

Get the current POI's that the device is currently known to be within:

ACPPlaces.getCurrentPointsOfInterest(function(response){  
    console.log("Current POI's: ", response);  
}, function(error){  
    console.log(error);  
});  

Get the last latitude and longitude stored in the Places plugin:

ACPPlaces.getLastKnownLocation(function(response) {  
    console.log("Last known location: ", response);
}, function(error){  
    console.log(error);  
});

Get a list of nearby POI's:

var location = {latitude:37.3309422, longitude:-121.8939077};
var limit = 10; // max number of POI's to return
ACPPlaces.getNearbyPointsOfInterest(location, limit, function(response){  
    console.log("Nearby POI's: ", response);  
}, function(error){  
    console.log(error);  
});

Pass a Geofence and transition type to be processed by the Places plugin:

var region = {latitude:37.3309422, longitude:-121.8939077, radius:1000};
var geofence = {requestId:"geofence_id", circularRegion:region, expirationDuration:-1};
ACPPlaces.processGeofence(geofence, geo.transitionType, function(response) {  
    console.log("Successfully processed geofence: ", geofence);
}, function(error){  
    console.log(error);  
});

Set the authorization status:

ACPPlaces.setAuthorizationStatus(ACPPlaces.AuthorizationStatusAlways, function(response) {  
    console.log("Successfully set the authorization status.");
}, function(error){  
    console.log(error);  
});

Running Tests

Install cordova-paramedic https://github.com/apache/cordova-paramedic

npm install -g cordova-paramedic

Run the tests

cordova-paramedic --platform ios --plugin . --verbose

cordova-paramedic --platform android --plugin . --verbose

Sample App

A Cordova app for testing the Adobe SDK plugins is located at https://github.com/adobe/cordova-acpsample. The app is configured for both iOS and Android platforms.

Additional Cordova Plugins

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

Extension	GitHub	npm
Core SDK	https://github.com/adobe/cordova-acpcore
Adobe Analytics	https://github.com/adobe/cordova-acpanalytics
Project Griffon (Beta)	https://github.com/adobe/cordova-acpgriffon

Contributing

Looking to contribute to this project? Please review our Contributing guidelines prior to opening a pull request.

We look forward to working with you!

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.