Newfangled Package Modernizer

    @adobe/cordova-acpcore

    1.0.0 • Public • Published

    Adobe Experience Platform - Core plugin for Cordova apps

    CI npm GitHub

    Prerequisites

    Cordova is distributed via npm (Node Package Management). In order to install and build Cordova applications you will need to have Node.js installed. Install Node.js. Once Node.js is installed, you can install the Cordova framework from terminal:

    sudo npm install -g cordova
    

    Installation

    To start using the AEP SDK for Cordova, navigate to the directory of your Cordova app and install the plugin:

    cordova plugin add https://github.com/adobe/cordova-acpcore.git
    

    Check out the documentation for help with APIs

    Usage

    Core

    Initialization

    iOS:

    // Import the SDK
    #import "ACPCore.h"
    #import "ACPLifecycle.h"
    #import "ACPIdentity.h"
    #import "ACPSignal.h"
    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {  
      // make sure to set the wrapper type at the beginning of initialization
      [ACPCore setWrapperType:ACPMobileWrapperTypeCordova];
    
      //...
      [ACPCore configureWithAppId:@"yourAppId"];
      [ACPIdentity registerExtension];
      [ACPLifecycle registerExtension];
      [ACPSignal registerExtension];
      // Register any additional extensions
    
      [ACPCore start:nil];
    }

    Android:

    // Import the SDK
    import com.adobe.marketing.mobile.MobileCore;
    import com.adobe.marketing.mobile.Identity;
    import com.adobe.marketing.mobile.Lifecycle;
    import com.adobe.marketing.mobile.Signal;
    import com.adobe.marketing.mobile.WrapperType;
    
    @Override
    public void onCreate() {
      //...
      MobileCore.setApplication(this);
      MobileCore.configureWithAppID("yourAppId");
    
      // make sure to set the wrapper type at the beginning of initialization
      MobileCore.setWrapperType(WrapperType.CORDOVA);
    
      try {
        Identity.registerExtension();
        Lifecycle.registerExtension();
        Signal.registerExtension();
    
        // Register any additional extensions
      } catch (Exception e) {
        // handle exception
      }
    
      MobileCore.start(null);
    }

    Core methods

    Getting Core version:
    ACPCore.extensionVersion(function(version) {
        console.log(version);
    }, function(error) {
        console.log(error);
    });
    Updating the SDK configuration:
    ACPCore.updateConfiguration({"newConfigKey":"newConfigValue"}, successCallback, errorCallback);
    Controlling the log level of the SDK:
    ACPCore.setLogLevel(ACPCore.ACPMobileLogLevelError, successCallback, errorCallback);
    ACPCore.setLogLevel(ACPCore.ACPMobileLogLevelWarning, successCallback, errorCallback);
    ACPCore.setLogLevel(ACPCore.ACPMobileLogLevelDebug, successCallback, errorCallback);
    ACPCore.setLogLevel(ACPCore.ACPMobileLogLevelVerbose, successCallback, errorCallback);
    Getting the current privacy status:
    ACPCore.getPrivacyStatus(function(privacyStatus) {
        console.log(privacyStatus);
    }, function(error) {
        console.log(error);
    });
    Setting the privacy status:
    ACPCore.setPrivacyStatus(ACPCore.ACPMobilePrivacyStatusOptIn, successCallback, errorCallback);
    ACPCore.setPrivacyStatus(ACPCore.ACPMobilePrivacyStatusOptOut, successCallback, errorCallback);
    ACPCore.setPrivacyStatus(ACPCore.ACPMobilePrivacyStatusUnknown, successCallback, errorCallback);
    Getting the SDK identities:
    ACPCore.getSdkIdentities(function(sdkIdentities) {
        console.log(sdkIdentities);
    }, function(error) {
        console.log(error);
    });
    Dispatching an Event Hub event:
    var e = ACPCore.createEvent("eventName", "eventType", "eventSource", {"key":"value"});
    ACPCore.dispatchEvent(e, successCallback, errorCallback);
    Dispatching an Event Hub event with callback:
    var e = ACPCore.createEvent("eventName", "eventType", "eventSource", {"key":"value"});
    ACPCore.dispatchEventWithResponseCallback(e, successCallback, errorCallback);
    Dispatching an Event Hub response event:
    var e1 = ACPCore.createEvent("eventName", "eventType", "eventSource", {"key":"value"});
    var e2 = ACPCore.createEvent("eventName2", "eventType", "eventSource", {"key":"value"});
    ACPCore.dispatchResponseEvent(e1, e2, successCallback, errorCallback);
    Downloading the Rules
    ACPCore.downloadRules(successCallback, errorCallback);
    Setting the advertising identifier:
    ACPCore.setAdvertisingIdentifier("someAdid", successCallback, errorCallback);
    Calling track action
    ACPCore.trackAction("cordovaAction", {"cordovaKey":"cordovaValue"}, successCallback, errorCallback);
    Calling track state
    ACPCore.trackState("cordovaState", {"cordovaKey":"cordovaValue"}, successCallback, errorCallback);

    Identity

    Getting Identity version:
    ACPIdentity.extensionVersion(function(version) {
        console.log(version);
    }, function(error) {
        console.log(error);
    });
    Sync Identifier:
    ACPIdentity.syncIdentifier("id1", "value1", ACPIdentity.ACPMobileVisitorAuthenticationStateUnknown, successCallback, errorCallback);
    Sync Identifiers:
    ACPIdentity.syncIdentifiers({"id2":"value2", "id3":"value3", "id4":"value4"}, successCallback, errorCallback);
    Sync Identifiers with Authentication State:
    ACPIdentity.syncIdentifiers({"id2":"value2", "id3":"value3", "id4":"value4"}, ACPIdentity.ACPMobileVisitorAuthenticationStateLoggedOut, successCallback, errorCallback);
    ACPIdentity.syncIdentifiers({"id2":"value2", "id3":"value3", "id4":"value4"}, ACPIdentity.ACPMobileVisitorAuthenticationStateAuthenticated, successCallback, errorCallback);
    ACPIdentity.syncIdentifiers({"id2":"value2", "id3":"value3", "id4":"value4"}, ACPIdentity.ACPMobileVisitorAuthenticationStateUnknown, successCallback, errorCallback);
    Append visitor data to a URL:
    ACPIdentity.appendVisitorInfoForUrl("https://www.adobe.com", successCallback, errorCallback);
    Get visitor data as URL query parameter string:
    ACPIdentity.getUrlVariables(function(variables) {
        console.log(variables);
    }, function(error) {
        console.log(error);
    });
    Get Identifiers:
    ACPIdentity.getIdentifiers(function(ids) {
        console.log(ids);
    }, function(error) {
        console.log(error);
    });
    Get Experience Cloud IDs:
    ACPIdentity.getExperienceCloudId(function(cloudId) {
        console.log(cloudId);
    }, function(error) {
        console.log(error);
    });

    Lifecycle

    Note: We recommend implementing Lifecycle in native Android and iOS code.

    Getting Lifecycle version:
    ACPLifecycle.extensionVersion(function(version) {
        console.log(version);
    }, function(error) {
        console.log(error);
    });

    Signal

    Getting Signal version:
    ACPSignal.extensionVersion(function(version) {
        console.log(version);
    }, function(error) {
        console.log(error);
    });

    Running Tests

    Install cordova-paramedic https://github.com/apache/cordova-paramedic

    npm install -g cordova-paramedic

    Run the tests

    cordova-paramedic --platform ios --plugin . --verbose
    
    cordova-paramedic --platform android --plugin . --verbose
    

    Sample App

    A Cordova app for testing the Adobe SDK plugins is located at https://github.com/adobe/cordova-acpsample. The app is configured for both iOS and Android platforms.

    Additional Cordova Plugins

    Below is a list of additional Cordova plugins from the AEP SDK suite:

    Extension GitHub npm
    Adobe Analytics https://github.com/adobe/cordova-acpanalytics npm
    Places https://github.com/adobe/cordova-acpplaces npm
    Project Griffon (Beta) https://github.com/adobe/cordova-acpgriffon npm

    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.

    Install

    npm i @adobe/cordova-acpcore

    DownloadsWeekly Downloads

    498

    Version

    1.0.0

    License

    Apache 2.0

    Unpacked Size

    130 kB

    Total Files

    35

    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