@adobe/react-native-aepplaces is a wrapper around the iOS and Android Adobe Experience Platform Places Extension to allow for integration with React Native applications. Functionality to enable Adobe Places is provided entirely through JavaScript documented below.
The Adobe Experience Platform Optimize extension has the following peer dependency, which must be installed prior to installing the optimize extension:
See Requirements and Installation instructions on the main page
Install the @adobe/react-native-aepplaces package:
NPM:
npm install @adobe/react-native-aepplacesYarn:
yarn add @adobe/react-native-aepplacesTo initialize the SDK, use the following methods:
Refer to the root Readme for more information about the SDK setup.
import {
Places,
PlacesAuthStatus,
PlacesGeofence,
PlacesGeofenceTransitionType,
PlacesLocation,
PlacesPOI,
} from "@adobe/react-native-aepplaces";Syntax
extensionVersion(): Promise<string>Example
const version = await Places.extensionVersion();
console.log(`AdobeExperienceSDK: Places version: ${version}`);Syntax
getNearbyPointsOfInterest(location, <limit>): Promise<Array<PlacesPOI>>Example
let location = new PlacesLocation(<latitude>, <longitude>, <optional altitude>, <optional speed>, <optional accuracy>);
try {
const pois = await Places.getNearbyPointsOfInterest(location, <limit>);
console.log(`AdobeExperienceSDK: Places pois: ${pois}`)
} catch(error) {
console.log(`AdobeExperienceSDK: Places error: ${error}`
}Syntax
processGeofence(geofence, <transitionType>): voidExample
// create a geofence
let geofence = new PlacesGeofence("geofence Identifier", <latitude>, <longitude>, <radius>, <optional expiration-duration>);
Places.processGeofence(geofence, PlacesGeofenceTransitionType.ENTER);
Places.processGeofence(geofence, PlacesGeofenceTransitionType.EXIT);Syntax
getCurrentPointsOfInterest(): Promise<Array<PlacesPOI>>Example
const pois = await Places.getCurrentPointsOfInterest();
console.log('AdobeExperienceSDK: Places pois: ' + pois);
);Syntax
getLastKnownLocation(): Promise<PlacesLocation>Example
const location = await Places.getLastKnownLocation();
console.log('AdobeExperienceSDK: Places location: ' + location)
);Syntax
clear(): voidExample
Places.clear();Syntax
setAuthorizationStatus(authStatus?: PlacesAuthStatus): void;Example
Places.setAuthorizationStatus(PlacesAuthStatus.ALWAYS);
Places.setAuthorizationStatus(PlacesAuthStatus.DENIED);
Places.setAuthorizationStatus(PlacesAuthStatus.RESTRICTED);
Places.setAuthorizationStatus(PlacesAuthStatus.WHEN_IN_USE);
Places.setAuthorizationStatus(PlacesAuthStatus.UNKNOWN);