React Native AEP Griffon Extension

@adobe/react-native-acpgriffon is a wrapper around the iOS and Android Project Griffon SDK to allow for integration with React Native applications. Functionality to start Griffon session is provided 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 Griffon 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-acpgriffon package:

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

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-acpgriffon

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

Griffon

Importing the extension:

import {ACPGriffon} from '@adobe/react-native-acpgriffon';

Getting the extension version:

ACPGriffon.getVersion().then(version => console.log("AdobeExperienceSDK: ACPGriffon 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. However, you can still initialize the SDK in Javascript. For more information see how to initialize Core.

iOS

#import <RCTACPGriffon/ACPGriffon.h>

[ACPGriffon registerExtension];

Android:

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

Start Griffon session:

import {ACPGriffon} from '@adobe/react-native-acpgriffon';
ACPGriffon.startSession("{your-griffon-session-url}");

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 | | | Places | |

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.