cordova-acpanalytics-fork

Adobe Experience Platform - Analytics plugin for Cordova apps (fork from https://github.com/adobe/cordova-acpanalytics).

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
cordova-acpanalytics-fork
001.0.52 years ago2 years agoMinified + gzip package size for cordova-acpanalytics-fork in KB

Readme

Adobe Experience Platform - Analytics 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 Analytics plugin for Cordova, navigate to the directory of your Cordova app and install the plugin: ``` cordova plugin add https://github.com/adobe/cordova-acpanalytics.git ``` Check out the documentation for help with APIs

Usage

Getting the SDK version:
```js ACPAnalytics.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 Core. ##### iOS ```objective-c
import "ACPAnalytics.h"
ACPAnalytics registerExtension; ``` ##### Android: ```java import com.adobe.marketing.mobile.Analytics; Analytics.registerExtension(); ```
Get the tracking identifier:
```js ACPAnalytics.getTrackingIdentifier(function(trackingId) {
console.log(trackingId);
}, function(error){
console.log(error);  
}); ```
Send queued hits:
```js ACPAnalytics.sendQueuedHits(function(response){
console.log("Success in sendQueuedHits");  
}, function(error){
console.log(error);  
}); ```
Get the queue size:
```js ACPAnalytics.getQueueSize(function(size) {
console.log(size);
}, function(error){
console.log(error);  
}); ```
Clear queued hits:
```js ACPAnalytics.clearQueue(function(response){
console.log("Success in clearing queue");  
}, function(error){
console.log(error);  
}); ```
Set the custom visitor identifier:
```js ACPAnalytics.setVisitorIdentifier(customVisitorId, function(response) {
console.log("Success in setting visitor Id with " + customVisitorId);  
}, function(error){
console.log(error);  
}); ```
Get the custom visitor identifier:
```js ACPAnalytics.getVisitorIdentifier(function(visitorId) {
console.log(visitorId);
}, function(error){
console.log(error);  
}); ```

Running Tests

Install cordova-paramedic https://github.com/apache/cordova-paramedic ```bash 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 | 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.