@adobe/react-native-acpcampaign

Adobe Experience Platform support for React Native apps.


Keywords
react-native, adobe, adobe experience platform, campaign, ios, android, adobe-campaign
License
Apache-2.0
Install
npm install @adobe/react-native-acpcampaign@2.0.0

Documentation

React Native AEP Campaign Standard Extension

npm version npm downloads CircleCI license

@adobe/react-native-acpcampaign is a wrapper around the iOS and Android AEP Campaign SDK to allow for integration with React Native applications. Functionality to enable Adobe Campaign Standard 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 Campaign 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-acpcampaign package:

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

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

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

Campaign

Importing the extension:
import {ACPCampaign} from '@adobe/react-native-acpcampaign';
Getting the extension version:
ACPCampaign.extensionVersion().then(version => console.log("AdobeExperienceSDK: ACPCampaign 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 <RCTACPCampaign/ACPCampaign.h>

[ACPCampaign registerExtension];
Android:
import com.adobe.marketing.mobile.Campaign;

Campaign.registerExtension();
Set linkage fields:
ACPCampaign.setLinkageFields({"linkageKey": "linkageValue"});
Reset linkage fields:
ACPCampaign.resetLinkageFields();

Contributing

See CONTRIBUTING

License

See LICENSE