@adobe/cordova-acpgriffon

    0.0.2 • Public • Published

    Adobe Experience Platform - Griffon plugin for Cordova apps

    CI npm GitHub

    Prerequisites

    Cordova is distributed via Node Package Management (aka - npm).

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

    Check out the documentation for help with APIs

    Usage

    Griffon

    Getting the SDK version:
    ACPGriffon.extensionVersion(function(version){  
      console.log(version);
    }, function(error){  
      console.log(error);  
    });
    Registering the extension with ACPCore:

    Note: It is required to initialize the SDK via native code inside your AppDelegate and MainApplication for iOS and Android respectively. For more information see how to initialize Griffon.

    iOS
    #import "ACPGriffon.h"  
    [ACPGriffon registerExtension];
    Android:
    import com.adobe.marketing.mobile.Griffon;
    Griffon.registerExtension();
    Starting the Griffon session:
    ACPGriffon.startSession(url, function(response) {  
      console.log("Success in starting Griffon session");  
    }, 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
    Core SDK https://github.com/adobe/cordova-acpcore npm
    Adobe Analytics https://github.com/adobe/cordova-acpanalytics npm
    Places https://github.com/adobe/cordova-acpplaces 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-acpgriffon

    DownloadsWeekly Downloads

    12

    Version

    0.0.2

    License

    Apache 2.0

    Unpacked Size

    40 kB

    Total Files

    26

    Last publish

    Collaborators

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