Narrowly Preventing Mayhem

    @adobe/react-native-aepedgeconsent

    1.0.0 • Public • Published

    React Native Consent for Edge Network Extension

    npm version npm downloads

    @adobe/react-native-aepedgeconsent is a wrapper for the iOS and Android Consent for Edge Network extension to allow for integration with React Native applications.

    Prerequisites

    The Consent for Edge Network extension has the following peer dependency, which must be installed prior to installing the Consent extension:

    Installation

    See Requirements and Installation instructions on the main page.

    Install the @adobe/react-native-aepedgeconsent package:

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

    Usage

    Installing and registering the extension with the AEP Mobile Core

    Install the Consent extension in your mobile property and configure the default consent preferences by following the steps in the Consent for Edge Network extension documentation.

    Then follow the same document for registering the Consent extension with the Mobile Core. Note that initializing the SDK should be done in native code, additional documentation on how to initialize the SDK can be found here.

    Initialization Example

    iOS

    // AppDelegate.h
    @import AEPCore;
    @import AEPEdge;
    @import AEPEdgeIdentity;
    @import AEPEdgeConsent;
    ...
    @implementation AppDelegate
    
    // AppDelegate.m
    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        [AEPMobileCore setLogLevel: AEPLogLevelDebug];
        [AEPMobileCore registerExtensions:@[AEPMobileEdgeIdentity.class, 
                                            AEPMobileEdge.class, 
                                            AEPMobileEdgeConsent.class] completion:^{
          [AEPMobileCore configureWithAppId:@"yourAppID"];  
        ...   
       }]; 
       return YES;   
     } 
    
    @end

    Android

    import com.adobe.marketing.mobile.LoggingMode;
    import com.adobe.marketing.mobile.MobileCore;
    import com.adobe.marketing.mobile.Edge;
    import com.adobe.marketing.mobile.edge.identity.Identity;
    import com.adobe.marketing.mobile.edge.consent.Consent;
      
    ...
    import android.app.Application;
    ...
    public class MainApplication extends Application implements ReactApplication {
      ...
      @Override
      public void on Create(){
        super.onCreate();
        ...
        MobileCore.setApplication(this);
        MobileCore.setLogLevel(LoggingMode.DEBUG);
        MobileCore.configureWithAppID("yourAppID");
    
        Edge.registerExtension();
        Identity.registerExtension();
        Consent.registerExtension();
        MobileCore.start(new AdobeCallback() {
            @Override
            public void call(Object o) {
            
            }});
      }
    }     

    Importing the extension

    In your React Native application, import the Consent extension as follows:

    import {Consent} from '@adobe/react-native-aepedgeconsent';

    API reference

    extensionVersion

    Returns the version of the Consent extension

    Syntax

    extensionVersion(): Promise<string>

    Example

    Consent.extensionVersion().then(version => console.log("Consent.extensionVersion: " + version));

    getConsents

    Retrieves the current consent preferences stored in the Consent extension and resolves the promise with the current consent preferences or rejects it if an unexpected error occurs or the request timed out. Output example: {"consents": {"collect": {"val": "y"}}}

    Syntax

    getConsents(): Promise<Record<string, any>>

    Example

    Consent.getConsents().then(consents => {
      console.log("AEPConsent.getConsents returned current consent preferences:  " + JSON.stringify(consents));
    }).catch((error) => {
      console.warn("AEPConsent.getConsents returned error: ", error.message);
    });

    update

    Merges the existing consents with the given consents. Duplicate keys will take the value of those passed in the API. Input example: {"consents": {"collect": {"val": "y"}}}

    Syntax

    update(consents: Record<string, any>) 

    Example

    var consents: {[keys: string]: any} = {"consents" : {"collect" : {"val": "y"}}};
    Consent.update(consents);

    Install

    npm i @adobe/react-native-aepedgeconsent

    DownloadsWeekly Downloads

    133

    Version

    1.0.0

    License

    Apache-2.0

    Unpacked Size

    51 kB

    Total Files

    23

    Last publish

    Collaborators

    • adobehalls
    • fullcolorcoder
    • marbec
    • tripod
    • garthdb
    • lazd
    • adobe-admin
    • patrickfulton
    • trieloff
    • shazron
    • krisnye
    • dcpfsdk
    • natebaldwin
    • devongovett
    • aspro83
    • symanovi
    • dpfister
    • stefan-guggisberg
    • korra
    • rofe
    • kptdobe