@adobe/react-native-acpaudience

    1.3.0 • Public • Published

    React Native AEP Audience Extension

    npm version npm downloads CircleCI license

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

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

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

    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

    Audience Manager

    Importing the extension:
    import {ACPAudience} from '@adobe/react-native-acpaudience';
    Getting the extension version:
    ACPAudience.extensionVersion().then(version => console.log("AdobeExperienceSDK: ACPAudience 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 <RCTACPAudience/ACPAudience.h>
    
    [ACPAudience registerExtension];
    Android:
    import com.adobe.marketing.mobile.Audience;
    
    Audience.registerExtension();
    Javascript
    import {ACPAudience} from '@adobe/react-native-acpaudience';
    
    ACPAudience.registerExtension();
    Send signals to Audience Manager:
    ACPAudience.signalWithData({"yourDataKey": "yourDataValue"}).then(profile => console.log("AdobeExperienceSDK: Visitor Profile: " + profile));
    Reset identifiers and profiles:
    ACPAudience.reset();
    Get the visitor profile:
    ACPAudience.getVisitorProfile().then(profile => console.log("AdobeExperienceSDK: Visitor Profile: " + profile));

    Contributing

    See CONTRIBUTING

    License

    See LICENSE

    Install

    npm i @adobe/react-native-acpaudience

    DownloadsWeekly Downloads

    186

    Version

    1.3.0

    License

    Apache-2.0

    Unpacked Size

    14.9 MB

    Total Files

    82

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar